1. Overview

Automatically-generated documentation based on Swagger and created by Springfox.

1.1. Version information

Version : 0.1-SNAPSHOT

1.2. Contact information

Contact : Siryus
Contact Email : you@siryus.com

1.3. License information

License : Proprietary
License URL : urn:licence
Terms of service : urn:tos

1.4. URI scheme

Host : localhost:42675
BasePath : /

1.5. Tags

  • Article Projects : Search or manage Article Project entries

  • Articles : Search or manage Article entries

  • Auth : User auth endpoints

  • Budget Units : Search or manage Budget Unit entries

  • Building Fmw Phases : Search or manage Building Fmw Phase entries

  • Building Fmw Statuses : Search or manage Building Fmw Status entries

  • Building Fmw Trades : Search or manage Building Fmw Trade entries

  • Building Fmws : Search or manage Building Fmw entries

  • Catalog Trees : Search or manage Catalog Tree entries

  • Category Enterprises : Search or manage Category Enterprise entries

  • Category Keys : Search or manage Category Key entries

  • Category Locations : Search or manage Category Location entries

  • Category Projects : Search or manage Category Project entries

  • Category Storage Urls : Search or manage Category Storage Url entries

  • Category Tasks : Search or manage Category Task entries

  • Category Users : Search or manage Category User entries

  • Contracts : Search or manage Contract entries

  • Countries : Search or manage Country entries

  • Currencies : Search or manage Currency entries

  • Enterprise Legal Types : Search or manage Enterprise Legal Type entries

  • Enterprise Roles : Search or manage Enterprise Role entries

  • Enterprise Trades : Search or manage Enterprise Trade entries

  • Enterprise Types : Search or manage Enterprise Type entries

  • Enterprise User Roles : Search or manage Enterprise User Role entries

  • Enterprises : Search or manage Enterprise entries

  • Invited Co Coes : Search or manage Invited Co Co entries

  • Lang Codes : Search or manage Lang Code entries

  • Location Roles : Search or manage Location Role entries

  • Location Statuses : Search or manage Location Status entries

  • Location Sub Types : Search or manage Location Sub Type entries

  • Location Trades : Search or manage Location Trade entries

  • Location Types : Search or manage Location Type entries

  • Location User Roles : Search or manage Location User Role entries

  • Locations : Search or manage Location entries

  • Log Entries : Search or manage Log Entry entries

  • Num Workers Of Enterprises : Search or manage Num Workers Of Enterprise entries

  • Offers : Search or manage Offer entries

  • Project Enterprise Co Coes : Search or manage Project Enterprise Co Co entries

  • Project Enterprise Not Co Coes : Search or manage Project Enterprise Not Co Co entries

  • Project Roles : Search or manage Project Role entries

  • Project Statuses : Search or manage Project Status entries

  • Project Types : Search or manage Project Type entries

  • Project User Roles : Search or manage Project User Role entries

  • Projects : Search or manage Project entries

  • Reference Building Frameworks : Search or manage Reference Building Framework entries

  • Requirements : Search or manage Requirement entries

  • Sc Articles : Search or manage Sc Article entries

  • Sc Variable Values : Search or manage Sc Variable Value entries

  • Sc Variables : Search or manage Sc Variable entries

  • Storage Urls : Search or manage Storage Url entries

  • Surface Units : Search or manage Surface Unit entries

  • Task Connection Types : Search or manage Task Connection Type entries

  • Task Locations : Search or manage Task Location entries

  • Task Roles : Search or manage Task Role entries

  • Task Trades : Search or manage Task Trade entries

  • Task Types : Search or manage Task Type entries

  • Task User Roles : Search or manage Task User Role entries

  • Task Work Log Types : Search or manage Task Work Log Type entries

  • Task Work Logs : Search or manage Task Work Log entries

  • Tasks : Search or manage Task entries

  • Tasks Connections : Search or manage Tasks Connection entries

  • Trades : Search or manage Trade entries

  • Types : Search or manage Type entries

  • Variables : Search or manage Variable entries

  • Volume Units : Search or manage Volume Unit entries

2. Resources

2.1. Article Projects

Search or manage Article Project entries

2.1.1. Create a new resource

POST /api/rest/articleProjects
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.1.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/articleProjects
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.1.3. Get CORS headers

OPTIONS /api/rest/articleProjects
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.1.4. Get JSON Schema

GET /api/rest/articleProjects/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.1.5. Get UI schema

GET /api/rest/articleProjects/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.1.6. Find by id

GET /api/rest/articleProjects/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.1.7. Update a resource

PUT /api/rest/articleProjects/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.1.8. Delete a resource

DELETE /api/rest/articleProjects/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.1.9. Patch (partially update) a resource

PATCH /api/rest/articleProjects/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.1.10. Find related by root id

GET /api/rest/articleProjects/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.1.11. Find related by root id

GET /api/rest/articleProjects/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.2. Articles

Search or manage Article entries

2.2.1. Create a new resource

POST /api/rest/articles
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.2.2. Search by ids

GET /api/rest/articles
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.2.3. Get CORS headers

OPTIONS /api/rest/articles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.2.4. Get JSON Schema

GET /api/rest/articles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.2.5. Get UI schema

GET /api/rest/articles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.2.6. Find by id

GET /api/rest/articles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.2.7. Update a resource

PUT /api/rest/articles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.2.8. Delete a resource

DELETE /api/rest/articles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.2.9. Patch (partially update) a resource

PATCH /api/rest/articles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.2.10. Find related by root id

GET /api/rest/articles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.2.11. Find related by root id

GET /api/rest/articles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.3. Auth

User auth endpoints

2.3.1. getContext

GET /api/rest/auth/context
Parameters
Type Name Description Schema

Query

expirationMillis
optional

expirationMillis

string

Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • */*

2.3.2. fetchFullToken

GET /api/rest/auth/fetch-full-token
Parameters
Type Name Description Schema

Header

Authorization
required

Authorization

string

Responses
HTTP Code Description Schema

200

OK

< string, string > map

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • */*

2.3.3. fetchNewToken

POST /api/rest/auth/fetch-new-auth-token
Parameters
Type Name Description Schema

Query

expirationMillis
optional

expirationMillis

string

Query

username
optional

username

string

Responses
HTTP Code Description Schema

200

OK

< string, string > map

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.4. forgotPassword

POST /api/rest/auth/forgot-password
Parameters
Type Name Description Schema

Query

email
required

email

string

Responses
HTTP Code Description Schema

201

Created

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.5. ping

GET /api/rest/auth/ping
Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • */*

2.3.6. resetPassword

POST /api/rest/auth/reset-password
Parameters
Type Name Description Schema

Body

form
required

form

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.7. signup

POST /api/rest/auth/users
Parameters
Type Name Description Schema

Body

user
required

user

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.8. fetchUserByEmail

POST /api/rest/auth/users/fetch-by-email
Parameters
Type Name Description Schema

Query

email
required

email

string

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.9. fetchUserById

GET /api/rest/auth/users/{id}
Parameters
Type Name Description Schema

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • */*

2.3.10. updateUser

PATCH /api/rest/auth/users/{id}
Parameters
Type Name Description Schema

Path

id
required

id

string

Body

patch
required

patch

string

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • */*

2.3.11. requestEmailChange

POST /api/rest/auth/users/{id}/email-change-request
Parameters
Type Name Description Schema

Path

id
required

id

string

Body

updatedUser
required

updatedUser

Responses
HTTP Code Description Schema

201

Created

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.12. changePassword

POST /api/rest/auth/users/{id}/password
Parameters
Type Name Description Schema

Path

id
required

id

string

Body

changePasswordForm
required

changePasswordForm

Responses
HTTP Code Description Schema

201

Created

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.13. resendVerificationMail

POST /api/rest/auth/users/{id}/resend-verification-mail
Parameters
Type Name Description Schema

Path

id
required

id

string

Responses
HTTP Code Description Schema

201

Created

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.14. verifyUser

POST /api/rest/auth/users/{id}/verification
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Query

code
required

code

string

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.3.15. changeEmail

POST /api/rest/auth/users/{userId}/email
Parameters
Type Name Description Schema

Path

userId
required

userId

integer (int32)

Query

code
required

code

string

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.4. Budget Units

Search or manage Budget Unit entries

2.4.1. Create a new HAL resource

POST /api/rest/budgetUnits
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.4.2. Search for resources (paginated).

GET /api/rest/budgetUnits
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.4.3. Get CORS headers

OPTIONS /api/rest/budgetUnits
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.4.4. Get JSON Schema

GET /api/rest/budgetUnits/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.4.5. Get UI schema

GET /api/rest/budgetUnits/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.4.6. Find by id

GET /api/rest/budgetUnits/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.4.7. Update a resource

PUT /api/rest/budgetUnits/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.4.8. Delete a resource

DELETE /api/rest/budgetUnits/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.4.9. Patch (partially update) a resource

PATCH /api/rest/budgetUnits/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.4.10. Find related by root id

GET /api/rest/budgetUnits/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.4.11. Find related by root id

GET /api/rest/budgetUnits/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.5. Building Fmw Phases

Search or manage Building Fmw Phase entries

2.5.1. Create a new resource

POST /api/rest/buildingFmwPhases
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.5.2. Search by ids

GET /api/rest/buildingFmwPhases
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.5.3. Get CORS headers

OPTIONS /api/rest/buildingFmwPhases
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.5.4. Get JSON Schema

GET /api/rest/buildingFmwPhases/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.5.5. Get UI schema

GET /api/rest/buildingFmwPhases/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.5.6. Find by id

GET /api/rest/buildingFmwPhases/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.5.7. Update a resource

PUT /api/rest/buildingFmwPhases/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.5.8. Delete a resource

DELETE /api/rest/buildingFmwPhases/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.5.9. Patch (partially update) a resource

PATCH /api/rest/buildingFmwPhases/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.5.10. Find related by root id

GET /api/rest/buildingFmwPhases/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.5.11. Find related by root id

GET /api/rest/buildingFmwPhases/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.6. Building Fmw Statuses

Search or manage Building Fmw Status entries

2.6.1. Create a new resource

POST /api/rest/buildingFmwStatuses
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.6.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/buildingFmwStatuses
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.6.3. Get CORS headers

OPTIONS /api/rest/buildingFmwStatuses
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.6.4. Get JSON Schema

GET /api/rest/buildingFmwStatuses/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.6.5. Get UI schema

GET /api/rest/buildingFmwStatuses/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.6.6. Find by id

GET /api/rest/buildingFmwStatuses/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.6.7. Update a resource

PUT /api/rest/buildingFmwStatuses/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.6.8. Delete a resource

DELETE /api/rest/buildingFmwStatuses/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.6.9. Patch (partially update) a resource

PATCH /api/rest/buildingFmwStatuses/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.6.10. Find related by root id

GET /api/rest/buildingFmwStatuses/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.6.11. Find related by root id

GET /api/rest/buildingFmwStatuses/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.7. Building Fmw Trades

Search or manage Building Fmw Trade entries

2.7.1. Create a new HAL resource

POST /api/rest/buildingFmwTrades
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.7.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/buildingFmwTrades
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.7.3. Get CORS headers

OPTIONS /api/rest/buildingFmwTrades
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.7.4. Get JSON Schema

GET /api/rest/buildingFmwTrades/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.7.5. Get UI schema

GET /api/rest/buildingFmwTrades/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.7.6. Find by id

GET /api/rest/buildingFmwTrades/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.7.7. Update a resource

PUT /api/rest/buildingFmwTrades/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.7.8. Delete a resource

DELETE /api/rest/buildingFmwTrades/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.7.9. Patch (partially update) a resource

PATCH /api/rest/buildingFmwTrades/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.7.10. Find related by root id

GET /api/rest/buildingFmwTrades/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.7.11. Find related by root id

GET /api/rest/buildingFmwTrades/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.8. Building Fmws

Search or manage Building Fmw entries

2.8.1. Create a new HAL resource

POST /api/rest/buildingFmws
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.8.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/buildingFmws
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.8.3. Get CORS headers

OPTIONS /api/rest/buildingFmws
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.8.4. Get JSON Schema

GET /api/rest/buildingFmws/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.8.5. Get UI schema

GET /api/rest/buildingFmws/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.8.6. Find by id

GET /api/rest/buildingFmws/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.8.7. Update a resource

PUT /api/rest/buildingFmws/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.8.8. Delete a resource

DELETE /api/rest/buildingFmws/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.8.9. Patch (partially update) a resource

PATCH /api/rest/buildingFmws/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.8.10. Find related by root id

GET /api/rest/buildingFmws/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.8.11. Find related by root id

GET /api/rest/buildingFmws/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.9. Catalog Trees

Search or manage Catalog Tree entries

2.9.1. Create a new resource

POST /api/rest/catalogTrees
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.9.2. Search for resources (paginated).

GET /api/rest/catalogTrees
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.9.3. Get CORS headers

OPTIONS /api/rest/catalogTrees
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.9.4. Get JSON Schema

GET /api/rest/catalogTrees/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.9.5. Get UI schema

GET /api/rest/catalogTrees/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.9.6. Find by id

GET /api/rest/catalogTrees/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.9.7. Update a resource

PUT /api/rest/catalogTrees/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.9.8. Delete a resource

DELETE /api/rest/catalogTrees/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.9.9. Patch (partially update) a resource

PATCH /api/rest/catalogTrees/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.9.10. Find related by root id

GET /api/rest/catalogTrees/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.9.11. Find related by root id

GET /api/rest/catalogTrees/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.10. Category Enterprises

Search or manage Category Enterprise entries

2.10.1. Create a new HAL resource

POST /api/rest/categoryEnterprises
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.10.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/categoryEnterprises
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.10.3. Get CORS headers

OPTIONS /api/rest/categoryEnterprises
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.10.4. Get JSON Schema

GET /api/rest/categoryEnterprises/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.10.5. Get UI schema

GET /api/rest/categoryEnterprises/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.10.6. Find by id

GET /api/rest/categoryEnterprises/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.10.7. Update a resource

PUT /api/rest/categoryEnterprises/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.10.8. Delete a resource

DELETE /api/rest/categoryEnterprises/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.10.9. Patch (partially update) a resource

PATCH /api/rest/categoryEnterprises/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.10.10. Find related by root id

GET /api/rest/categoryEnterprises/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.10.11. Find related by root id

GET /api/rest/categoryEnterprises/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.11. Category Keys

Search or manage Category Key entries

2.11.1. Create a new resource

POST /api/rest/categoryKeys
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.11.2. Search by ids

GET /api/rest/categoryKeys
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.11.3. Get CORS headers

OPTIONS /api/rest/categoryKeys
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.11.4. Get JSON Schema

GET /api/rest/categoryKeys/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.11.5. Get UI schema

GET /api/rest/categoryKeys/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.11.6. Find by id

GET /api/rest/categoryKeys/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.11.7. Update a resource

PUT /api/rest/categoryKeys/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.11.8. Delete a resource

DELETE /api/rest/categoryKeys/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.11.9. Patch (partially update) a resource

PATCH /api/rest/categoryKeys/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.11.10. Find related by root id

GET /api/rest/categoryKeys/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.11.11. Find related by root id

GET /api/rest/categoryKeys/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.12. Category Locations

Search or manage Category Location entries

2.12.1. Create a new resource

POST /api/rest/categoryLocations
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.12.2. Search by ids

GET /api/rest/categoryLocations
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.12.3. Get CORS headers

OPTIONS /api/rest/categoryLocations
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.12.4. Get JSON Schema

GET /api/rest/categoryLocations/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.12.5. Get UI schema

GET /api/rest/categoryLocations/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.12.6. Find by id

GET /api/rest/categoryLocations/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.12.7. Update a resource

PUT /api/rest/categoryLocations/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.12.8. Delete a resource

DELETE /api/rest/categoryLocations/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.12.9. Patch (partially update) a resource

PATCH /api/rest/categoryLocations/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.12.10. Find related by root id

GET /api/rest/categoryLocations/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.12.11. Find related by root id

GET /api/rest/categoryLocations/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.13. Category Projects

Search or manage Category Project entries

2.13.1. Create a new HAL resource

POST /api/rest/categoryProjects
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.13.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/categoryProjects
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.13.3. Get CORS headers

OPTIONS /api/rest/categoryProjects
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.13.4. Get JSON Schema

GET /api/rest/categoryProjects/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.13.5. Get UI schema

GET /api/rest/categoryProjects/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.13.6. Find by id

GET /api/rest/categoryProjects/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.13.7. Update a resource

PUT /api/rest/categoryProjects/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.13.8. Delete a resource

DELETE /api/rest/categoryProjects/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.13.9. Patch (partially update) a resource

PATCH /api/rest/categoryProjects/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.13.10. Find related by root id

GET /api/rest/categoryProjects/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.13.11. Find related by root id

GET /api/rest/categoryProjects/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.14. Category Storage Urls

Search or manage Category Storage Url entries

2.14.1. Create a new resource

POST /api/rest/categoryStorageUrls
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.14.2. Search by ids

GET /api/rest/categoryStorageUrls
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.14.3. Get CORS headers

OPTIONS /api/rest/categoryStorageUrls
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.14.4. Get JSON Schema

GET /api/rest/categoryStorageUrls/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.14.5. Get UI schema

GET /api/rest/categoryStorageUrls/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.14.6. Find by id

GET /api/rest/categoryStorageUrls/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.14.7. Update a resource

PUT /api/rest/categoryStorageUrls/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.14.8. Delete a resource

DELETE /api/rest/categoryStorageUrls/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.14.9. Patch (partially update) a resource

PATCH /api/rest/categoryStorageUrls/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.14.10. Find related by root id

GET /api/rest/categoryStorageUrls/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.14.11. Find related by root id

GET /api/rest/categoryStorageUrls/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.15. Category Tasks

Search or manage Category Task entries

2.15.1. Create a new HAL resource

POST /api/rest/categoryTasks
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.15.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/categoryTasks
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.15.3. Get CORS headers

OPTIONS /api/rest/categoryTasks
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.15.4. Get JSON Schema

GET /api/rest/categoryTasks/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.15.5. Get UI schema

GET /api/rest/categoryTasks/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.15.6. Find by id

GET /api/rest/categoryTasks/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.15.7. Update a resource

PUT /api/rest/categoryTasks/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.15.8. Delete a resource

DELETE /api/rest/categoryTasks/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.15.9. Patch (partially update) a resource

PATCH /api/rest/categoryTasks/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.15.10. Find related by root id

GET /api/rest/categoryTasks/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.15.11. Find related by root id

GET /api/rest/categoryTasks/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.16. Category Users

Search or manage Category User entries

2.16.1. Create a new HAL resource

POST /api/rest/categoryUsers
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.16.2. Search for resources (paginated).

GET /api/rest/categoryUsers
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.16.3. Get CORS headers

OPTIONS /api/rest/categoryUsers
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.16.4. Get JSON Schema

GET /api/rest/categoryUsers/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.16.5. Get UI schema

GET /api/rest/categoryUsers/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.16.6. Find by id

GET /api/rest/categoryUsers/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.16.7. Update a resource

PUT /api/rest/categoryUsers/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.16.8. Delete a resource

DELETE /api/rest/categoryUsers/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.16.9. Patch (partially update) a resource

PATCH /api/rest/categoryUsers/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.16.10. Find related by root id

GET /api/rest/categoryUsers/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.16.11. Find related by root id

GET /api/rest/categoryUsers/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.17. Contracts

Search or manage Contract entries

2.17.1. Create a new resource

POST /api/rest/contracts
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.17.2. Search by ids

GET /api/rest/contracts
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.17.3. Get CORS headers

OPTIONS /api/rest/contracts
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.17.4. Get JSON Schema

GET /api/rest/contracts/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.17.5. Get UI schema

GET /api/rest/contracts/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.17.6. Find by id

GET /api/rest/contracts/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.17.7. Update a resource

PUT /api/rest/contracts/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.17.8. Delete a resource

DELETE /api/rest/contracts/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.17.9. Patch (partially update) a resource

PATCH /api/rest/contracts/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.17.10. Find related by root id

GET /api/rest/contracts/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.17.11. Find related by root id

GET /api/rest/contracts/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.18. Countries

Search or manage Country entries

2.18.1. Create a new resource

POST /api/rest/countries
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.18.2. Search by ids

GET /api/rest/countries
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.18.3. Get CORS headers

OPTIONS /api/rest/countries
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.18.4. Get JSON Schema

GET /api/rest/countries/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.18.5. Get UI schema

GET /api/rest/countries/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.18.6. Find by id

GET /api/rest/countries/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.18.7. Update a resource

PUT /api/rest/countries/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.18.8. Delete a resource

DELETE /api/rest/countries/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.18.9. Patch (partially update) a resource

PATCH /api/rest/countries/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.18.10. Find related by root id

GET /api/rest/countries/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.18.11. Find related by root id

GET /api/rest/countries/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.19. Currencies

Search or manage Currency entries

2.19.1. Create a new resource

POST /api/rest/currencies
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.19.2. Search for resources (paginated).

GET /api/rest/currencies
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.19.3. Get CORS headers

OPTIONS /api/rest/currencies
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.19.4. Get JSON Schema

GET /api/rest/currencies/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.19.5. Get UI schema

GET /api/rest/currencies/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.19.6. Find by id

GET /api/rest/currencies/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.19.7. Update a resource

PUT /api/rest/currencies/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.19.8. Delete a resource

DELETE /api/rest/currencies/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.19.9. Patch (partially update) a resource

PATCH /api/rest/currencies/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.19.10. Find related by root id

GET /api/rest/currencies/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.19.11. Find related by root id

GET /api/rest/currencies/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

Search or manage Enterprise Legal Type entries

2.20.1. Create a new HAL resource

POST /api/rest/enterpriseLegalTypes
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.20.2. Search for resources (paginated).

GET /api/rest/enterpriseLegalTypes
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.20.3. Get CORS headers

OPTIONS /api/rest/enterpriseLegalTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.20.4. Get JSON Schema

GET /api/rest/enterpriseLegalTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.20.5. Get UI schema

GET /api/rest/enterpriseLegalTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.20.6. Find by id

GET /api/rest/enterpriseLegalTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.20.7. Update a resource

PUT /api/rest/enterpriseLegalTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.20.8. Delete a resource

DELETE /api/rest/enterpriseLegalTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.20.9. Patch (partially update) a resource

PATCH /api/rest/enterpriseLegalTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.20.10. Find related by root id

GET /api/rest/enterpriseLegalTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.20.11. Find related by root id

GET /api/rest/enterpriseLegalTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.21. Enterprise Roles

Search or manage Enterprise Role entries

2.21.1. Create a new resource

POST /api/rest/enterpriseRoles
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.21.2. Search by ids

GET /api/rest/enterpriseRoles
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.21.3. Get CORS headers

OPTIONS /api/rest/enterpriseRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.21.4. Get JSON Schema

GET /api/rest/enterpriseRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.21.5. Get UI schema

GET /api/rest/enterpriseRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.21.6. Find by id

GET /api/rest/enterpriseRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.21.7. Update a resource

PUT /api/rest/enterpriseRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.21.8. Delete a resource

DELETE /api/rest/enterpriseRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.21.9. Patch (partially update) a resource

PATCH /api/rest/enterpriseRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.21.10. Find related by root id

GET /api/rest/enterpriseRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.21.11. Find related by root id

GET /api/rest/enterpriseRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.22. Enterprise Trades

Search or manage Enterprise Trade entries

2.22.1. Create a new resource

POST /api/rest/enterpriseTrades
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.22.2. Search by ids

GET /api/rest/enterpriseTrades
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.22.3. Get CORS headers

OPTIONS /api/rest/enterpriseTrades
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.22.4. Get JSON Schema

GET /api/rest/enterpriseTrades/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.22.5. Get UI schema

GET /api/rest/enterpriseTrades/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.22.6. Find by id

GET /api/rest/enterpriseTrades/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.22.7. Update a resource

PUT /api/rest/enterpriseTrades/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.22.8. Delete a resource

DELETE /api/rest/enterpriseTrades/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.22.9. Patch (partially update) a resource

PATCH /api/rest/enterpriseTrades/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.22.10. Find related by root id

GET /api/rest/enterpriseTrades/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.22.11. Find related by root id

GET /api/rest/enterpriseTrades/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.23. Enterprise Types

Search or manage Enterprise Type entries

2.23.1. Create a new resource

POST /api/rest/enterpriseTypes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.23.2. Search by ids

GET /api/rest/enterpriseTypes
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.23.3. Get CORS headers

OPTIONS /api/rest/enterpriseTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.23.4. Get JSON Schema

GET /api/rest/enterpriseTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.23.5. Get UI schema

GET /api/rest/enterpriseTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.23.6. Find by id

GET /api/rest/enterpriseTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.23.7. Update a resource

PUT /api/rest/enterpriseTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.23.8. Delete a resource

DELETE /api/rest/enterpriseTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.23.9. Patch (partially update) a resource

PATCH /api/rest/enterpriseTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.23.10. Find related by root id

GET /api/rest/enterpriseTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.23.11. Find related by root id

GET /api/rest/enterpriseTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.24. Enterprise User Roles

Search or manage Enterprise User Role entries

2.24.1. Create a new HAL resource

POST /api/rest/enterpriseUserRoles
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.24.2. Search by ids

GET /api/rest/enterpriseUserRoles
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.24.3. Get CORS headers

OPTIONS /api/rest/enterpriseUserRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.24.4. Get JSON Schema

GET /api/rest/enterpriseUserRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.24.5. Get UI schema

GET /api/rest/enterpriseUserRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.24.6. Find by id

GET /api/rest/enterpriseUserRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.24.7. Update a resource

PUT /api/rest/enterpriseUserRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.24.8. Delete a resource

DELETE /api/rest/enterpriseUserRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.24.9. Patch (partially update) a resource

PATCH /api/rest/enterpriseUserRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.24.10. Find related by root id

GET /api/rest/enterpriseUserRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.24.11. Find related by root id

GET /api/rest/enterpriseUserRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.25. Enterprises

Search or manage Enterprise entries

2.25.1. Create a new HAL resource

POST /api/rest/enterprises
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.25.2. Search for resources (paginated).

GET /api/rest/enterprises
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.25.3. Get CORS headers

OPTIONS /api/rest/enterprises
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.25.4. Get JSON Schema

GET /api/rest/enterprises/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.25.5. Get UI schema

GET /api/rest/enterprises/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.25.6. Find by id

GET /api/rest/enterprises/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.25.7. Update a resource

PUT /api/rest/enterprises/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.25.8. Delete a resource

DELETE /api/rest/enterprises/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.25.9. Patch (partially update) a resource

PATCH /api/rest/enterprises/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.25.10. Find related by root id

GET /api/rest/enterprises/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.25.11. Find related by root id

GET /api/rest/enterprises/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.26. Invited Co Coes

Search or manage Invited Co Co entries

2.26.1. Create a new resource

POST /api/rest/invitedCoCoes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.26.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/invitedCoCoes
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.26.3. Get CORS headers

OPTIONS /api/rest/invitedCoCoes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.26.4. Get JSON Schema

GET /api/rest/invitedCoCoes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.26.5. Get UI schema

GET /api/rest/invitedCoCoes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.26.6. Find by id

GET /api/rest/invitedCoCoes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.26.7. Update a resource

PUT /api/rest/invitedCoCoes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.26.8. Delete a resource

DELETE /api/rest/invitedCoCoes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.26.9. Patch (partially update) a resource

PATCH /api/rest/invitedCoCoes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.26.10. Find related by root id

GET /api/rest/invitedCoCoes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.26.11. Find related by root id

GET /api/rest/invitedCoCoes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.27. Lang Codes

Search or manage Lang Code entries

2.27.1. Create a new HAL resource

POST /api/rest/langCodes
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.27.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/langCodes
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.27.3. Get CORS headers

OPTIONS /api/rest/langCodes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.27.4. Get JSON Schema

GET /api/rest/langCodes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.27.5. Get UI schema

GET /api/rest/langCodes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.27.6. Find by id

GET /api/rest/langCodes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.27.7. Update a resource

PUT /api/rest/langCodes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.27.8. Delete a resource

DELETE /api/rest/langCodes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.27.9. Patch (partially update) a resource

PATCH /api/rest/langCodes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.27.10. Find related by root id

GET /api/rest/langCodes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.27.11. Find related by root id

GET /api/rest/langCodes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.28. Location Roles

Search or manage Location Role entries

2.28.1. Create a new resource

POST /api/rest/locationRoles
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.28.2. Search for resources (paginated).

GET /api/rest/locationRoles
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.28.3. Get CORS headers

OPTIONS /api/rest/locationRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.28.4. Get JSON Schema

GET /api/rest/locationRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.28.5. Get UI schema

GET /api/rest/locationRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.28.6. Find by id

GET /api/rest/locationRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.28.7. Update a resource

PUT /api/rest/locationRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.28.8. Delete a resource

DELETE /api/rest/locationRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.28.9. Patch (partially update) a resource

PATCH /api/rest/locationRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.28.10. Find related by root id

GET /api/rest/locationRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.28.11. Find related by root id

GET /api/rest/locationRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.29. Location Statuses

Search or manage Location Status entries

2.29.1. Create a new resource

POST /api/rest/locationStatuses
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.29.2. Search for resources (paginated).

GET /api/rest/locationStatuses
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.29.3. Get CORS headers

OPTIONS /api/rest/locationStatuses
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.29.4. Get JSON Schema

GET /api/rest/locationStatuses/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.29.5. Get UI schema

GET /api/rest/locationStatuses/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.29.6. Find by id

GET /api/rest/locationStatuses/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.29.7. Update a resource

PUT /api/rest/locationStatuses/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.29.8. Delete a resource

DELETE /api/rest/locationStatuses/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.29.9. Patch (partially update) a resource

PATCH /api/rest/locationStatuses/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.29.10. Find related by root id

GET /api/rest/locationStatuses/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.29.11. Find related by root id

GET /api/rest/locationStatuses/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.30. Location Sub Types

Search or manage Location Sub Type entries

2.30.1. Create a new resource

POST /api/rest/locationSubTypes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.30.2. Search for resources (paginated).

GET /api/rest/locationSubTypes
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.30.3. Get CORS headers

OPTIONS /api/rest/locationSubTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.30.4. Get JSON Schema

GET /api/rest/locationSubTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.30.5. Get UI schema

GET /api/rest/locationSubTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.30.6. Find by id

GET /api/rest/locationSubTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.30.7. Update a resource

PUT /api/rest/locationSubTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.30.8. Delete a resource

DELETE /api/rest/locationSubTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.30.9. Patch (partially update) a resource

PATCH /api/rest/locationSubTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.30.10. Find related by root id

GET /api/rest/locationSubTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.30.11. Find related by root id

GET /api/rest/locationSubTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.31. Location Trades

Search or manage Location Trade entries

2.31.1. Create a new HAL resource

POST /api/rest/locationTrades
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.31.2. Search by ids

GET /api/rest/locationTrades
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.31.3. Get CORS headers

OPTIONS /api/rest/locationTrades
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.31.4. Get JSON Schema

GET /api/rest/locationTrades/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.31.5. Get UI schema

GET /api/rest/locationTrades/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.31.6. Find by id

GET /api/rest/locationTrades/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.31.7. Update a resource

PUT /api/rest/locationTrades/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.31.8. Delete a resource

DELETE /api/rest/locationTrades/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.31.9. Patch (partially update) a resource

PATCH /api/rest/locationTrades/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.31.10. Find related by root id

GET /api/rest/locationTrades/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.31.11. Find related by root id

GET /api/rest/locationTrades/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.32. Location Types

Search or manage Location Type entries

2.32.1. Create a new HAL resource

POST /api/rest/locationTypes
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.32.2. Search for resources (paginated).

GET /api/rest/locationTypes
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.32.3. Get CORS headers

OPTIONS /api/rest/locationTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.32.4. Get JSON Schema

GET /api/rest/locationTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.32.5. Get UI schema

GET /api/rest/locationTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.32.6. Find by id

GET /api/rest/locationTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.32.7. Update a resource

PUT /api/rest/locationTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.32.8. Delete a resource

DELETE /api/rest/locationTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.32.9. Patch (partially update) a resource

PATCH /api/rest/locationTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.32.10. Find related by root id

GET /api/rest/locationTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.32.11. Find related by root id

GET /api/rest/locationTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.33. Location User Roles

Search or manage Location User Role entries

2.33.1. Create a new resource

POST /api/rest/locationUserRoles
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.33.2. Search by ids

GET /api/rest/locationUserRoles
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.33.3. Get CORS headers

OPTIONS /api/rest/locationUserRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.33.4. Get JSON Schema

GET /api/rest/locationUserRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.33.5. Get UI schema

GET /api/rest/locationUserRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.33.6. Find by id

GET /api/rest/locationUserRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.33.7. Update a resource

PUT /api/rest/locationUserRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.33.8. Delete a resource

DELETE /api/rest/locationUserRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.33.9. Patch (partially update) a resource

PATCH /api/rest/locationUserRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.33.10. Find related by root id

GET /api/rest/locationUserRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.33.11. Find related by root id

GET /api/rest/locationUserRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.34. Locations

Search or manage Location entries

2.34.1. Create a new HAL resource

POST /api/rest/locations
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.34.2. Search by ids

GET /api/rest/locations
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.34.3. Get CORS headers

OPTIONS /api/rest/locations
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.34.4. Get JSON Schema

GET /api/rest/locations/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.34.5. Get UI schema

GET /api/rest/locations/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.34.6. Find by id

GET /api/rest/locations/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.34.7. Update a resource

PUT /api/rest/locations/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.34.8. Delete a resource

DELETE /api/rest/locations/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.34.9. Patch (partially update) a resource

PATCH /api/rest/locations/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.34.10. Find related by root id

GET /api/rest/locations/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.34.11. Find related by root id

GET /api/rest/locations/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.35. Log Entries

Search or manage Log Entry entries

2.35.1. Create a new HAL resource

POST /api/rest/logEntries
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.35.2. Search for resources (paginated).

GET /api/rest/logEntries
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.35.3. Get CORS headers

OPTIONS /api/rest/logEntries
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.35.4. Get JSON Schema

GET /api/rest/logEntries/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.35.5. Get UI schema

GET /api/rest/logEntries/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.35.6. Find by id

GET /api/rest/logEntries/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.35.7. Update a resource

PUT /api/rest/logEntries/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.35.8. Delete a resource

DELETE /api/rest/logEntries/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.35.9. Patch (partially update) a resource

PATCH /api/rest/logEntries/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.35.10. Find related by root id

GET /api/rest/logEntries/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.35.11. Find related by root id

GET /api/rest/logEntries/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.36. Num Workers Of Enterprises

Search or manage Num Workers Of Enterprise entries

2.36.1. Create a new resource

POST /api/rest/numWorkersOfEnterprises
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.36.2. Search by ids

GET /api/rest/numWorkersOfEnterprises
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.36.3. Get CORS headers

OPTIONS /api/rest/numWorkersOfEnterprises
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.36.4. Get JSON Schema

GET /api/rest/numWorkersOfEnterprises/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.36.5. Get UI schema

GET /api/rest/numWorkersOfEnterprises/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.36.6. Find by id

GET /api/rest/numWorkersOfEnterprises/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.36.7. Update a resource

PUT /api/rest/numWorkersOfEnterprises/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.36.8. Delete a resource

DELETE /api/rest/numWorkersOfEnterprises/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.36.9. Patch (partially update) a resource

PATCH /api/rest/numWorkersOfEnterprises/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.36.10. Find related by root id

GET /api/rest/numWorkersOfEnterprises/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.36.11. Find related by root id

GET /api/rest/numWorkersOfEnterprises/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.37. Offers

Search or manage Offer entries

2.37.1. Create a new resource

POST /api/rest/offers
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.37.2. Search for resources (paginated).

GET /api/rest/offers
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.37.3. Get CORS headers

OPTIONS /api/rest/offers
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.37.4. Get JSON Schema

GET /api/rest/offers/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.37.5. Get UI schema

GET /api/rest/offers/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.37.6. Find by id

GET /api/rest/offers/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.37.7. Update a resource

PUT /api/rest/offers/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.37.8. Delete a resource

DELETE /api/rest/offers/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.37.9. Patch (partially update) a resource

PATCH /api/rest/offers/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.37.10. Find related by root id

GET /api/rest/offers/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.37.11. Find related by root id

GET /api/rest/offers/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.38. Project Enterprise Co Coes

Search or manage Project Enterprise Co Co entries

2.38.1. Create a new resource

POST /api/rest/projectEnterpriseCoCoes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.38.2. Search by ids

GET /api/rest/projectEnterpriseCoCoes
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.38.3. Get CORS headers

OPTIONS /api/rest/projectEnterpriseCoCoes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.38.4. Get JSON Schema

GET /api/rest/projectEnterpriseCoCoes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.38.5. Get UI schema

GET /api/rest/projectEnterpriseCoCoes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.38.6. Find by id

GET /api/rest/projectEnterpriseCoCoes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.38.7. Update a resource

PUT /api/rest/projectEnterpriseCoCoes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.38.8. Delete a resource

DELETE /api/rest/projectEnterpriseCoCoes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.38.9. Patch (partially update) a resource

PATCH /api/rest/projectEnterpriseCoCoes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.38.10. Find related by root id

GET /api/rest/projectEnterpriseCoCoes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.38.11. Find related by root id

GET /api/rest/projectEnterpriseCoCoes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.39. Project Enterprise Not Co Coes

Search or manage Project Enterprise Not Co Co entries

2.39.1. Create a new HAL resource

POST /api/rest/projectEnterpriseNotCoCoes
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.39.2. Search by ids

GET /api/rest/projectEnterpriseNotCoCoes
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.39.3. Get CORS headers

OPTIONS /api/rest/projectEnterpriseNotCoCoes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.39.4. Get JSON Schema

GET /api/rest/projectEnterpriseNotCoCoes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.39.5. Get UI schema

GET /api/rest/projectEnterpriseNotCoCoes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.39.6. Find by id

GET /api/rest/projectEnterpriseNotCoCoes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.39.7. Update a resource

PUT /api/rest/projectEnterpriseNotCoCoes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.39.8. Delete a resource

DELETE /api/rest/projectEnterpriseNotCoCoes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.39.9. Patch (partially update) a resource

PATCH /api/rest/projectEnterpriseNotCoCoes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.39.10. Find related by root id

GET /api/rest/projectEnterpriseNotCoCoes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.39.11. Find related by root id

GET /api/rest/projectEnterpriseNotCoCoes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.40. Project Roles

Search or manage Project Role entries

2.40.1. Create a new resource

POST /api/rest/projectRoles
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.40.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/projectRoles
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.40.3. Get CORS headers

OPTIONS /api/rest/projectRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.40.4. Get JSON Schema

GET /api/rest/projectRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.40.5. Get UI schema

GET /api/rest/projectRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.40.6. Find by id

GET /api/rest/projectRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.40.7. Update a resource

PUT /api/rest/projectRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.40.8. Delete a resource

DELETE /api/rest/projectRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.40.9. Patch (partially update) a resource

PATCH /api/rest/projectRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.40.10. Find related by root id

GET /api/rest/projectRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.40.11. Find related by root id

GET /api/rest/projectRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.41. Project Statuses

Search or manage Project Status entries

2.41.1. Create a new resource

POST /api/rest/projectStatuses
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.41.2. Search by ids

GET /api/rest/projectStatuses
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.41.3. Get CORS headers

OPTIONS /api/rest/projectStatuses
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.41.4. Get JSON Schema

GET /api/rest/projectStatuses/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.41.5. Get UI schema

GET /api/rest/projectStatuses/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.41.6. Find by id

GET /api/rest/projectStatuses/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.41.7. Update a resource

PUT /api/rest/projectStatuses/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.41.8. Delete a resource

DELETE /api/rest/projectStatuses/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.41.9. Patch (partially update) a resource

PATCH /api/rest/projectStatuses/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.41.10. Find related by root id

GET /api/rest/projectStatuses/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.41.11. Find related by root id

GET /api/rest/projectStatuses/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.42. Project Types

Search or manage Project Type entries

2.42.1. Create a new resource

POST /api/rest/projectTypes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.42.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/projectTypes
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.42.3. Get CORS headers

OPTIONS /api/rest/projectTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.42.4. Get JSON Schema

GET /api/rest/projectTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.42.5. Get UI schema

GET /api/rest/projectTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.42.6. Find by id

GET /api/rest/projectTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.42.7. Update a resource

PUT /api/rest/projectTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.42.8. Delete a resource

DELETE /api/rest/projectTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.42.9. Patch (partially update) a resource

PATCH /api/rest/projectTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.42.10. Find related by root id

GET /api/rest/projectTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.42.11. Find related by root id

GET /api/rest/projectTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.43. Project User Roles

Search or manage Project User Role entries

2.43.1. Create a new HAL resource

POST /api/rest/projectUserRoles
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.43.2. Search for resources (paginated).

GET /api/rest/projectUserRoles
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.43.3. Get CORS headers

OPTIONS /api/rest/projectUserRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.43.4. Get JSON Schema

GET /api/rest/projectUserRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.43.5. Get UI schema

GET /api/rest/projectUserRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.43.6. Find by id

GET /api/rest/projectUserRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.43.7. Update a resource

PUT /api/rest/projectUserRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.43.8. Delete a resource

DELETE /api/rest/projectUserRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.43.9. Patch (partially update) a resource

PATCH /api/rest/projectUserRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.43.10. Find related by root id

GET /api/rest/projectUserRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.43.11. Find related by root id

GET /api/rest/projectUserRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.44. Projects

Search or manage Project entries

2.44.1. Create a new HAL resource

POST /api/rest/projects
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.44.2. Search for resources (paginated).

GET /api/rest/projects
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.44.3. Get CORS headers

OPTIONS /api/rest/projects
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.44.4. Get JSON Schema

GET /api/rest/projects/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.44.5. Get UI schema

GET /api/rest/projects/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.44.6. Find by id

GET /api/rest/projects/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.44.7. Update a resource

PUT /api/rest/projects/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.44.8. Delete a resource

DELETE /api/rest/projects/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.44.9. Patch (partially update) a resource

PATCH /api/rest/projects/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.44.10. Find related by root id

GET /api/rest/projects/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.44.11. Find related by root id

GET /api/rest/projects/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.45. Reference Building Frameworks

Search or manage Reference Building Framework entries

2.45.1. Create a new HAL resource

POST /api/rest/referenceBuildingFrameworks
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.45.2. Search for resources (paginated).

GET /api/rest/referenceBuildingFrameworks
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.45.3. Get CORS headers

OPTIONS /api/rest/referenceBuildingFrameworks
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.45.4. Get JSON Schema

GET /api/rest/referenceBuildingFrameworks/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.45.5. Get UI schema

GET /api/rest/referenceBuildingFrameworks/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.45.6. Find by id

GET /api/rest/referenceBuildingFrameworks/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.45.7. Update a resource

PUT /api/rest/referenceBuildingFrameworks/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.45.8. Delete a resource

DELETE /api/rest/referenceBuildingFrameworks/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.45.9. Patch (partially update) a resource

PATCH /api/rest/referenceBuildingFrameworks/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.45.10. Find related by root id

GET /api/rest/referenceBuildingFrameworks/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.45.11. Find related by root id

GET /api/rest/referenceBuildingFrameworks/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.46. Requirements

Search or manage Requirement entries

2.46.1. Create a new HAL resource

POST /api/rest/requirements
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.46.2. Search by ids

GET /api/rest/requirements
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.46.3. Get CORS headers

OPTIONS /api/rest/requirements
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.46.4. Get JSON Schema

GET /api/rest/requirements/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.46.5. Get UI schema

GET /api/rest/requirements/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.46.6. Find by id

GET /api/rest/requirements/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.46.7. Update a resource

PUT /api/rest/requirements/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.46.8. Delete a resource

DELETE /api/rest/requirements/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.46.9. Patch (partially update) a resource

PATCH /api/rest/requirements/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.46.10. Find related by root id

GET /api/rest/requirements/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.46.11. Find related by root id

GET /api/rest/requirements/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.47. Sc Articles

Search or manage Sc Article entries

2.47.1. Create a new HAL resource

POST /api/rest/scArticles
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.47.2. Search by ids

GET /api/rest/scArticles
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.47.3. Get CORS headers

OPTIONS /api/rest/scArticles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.47.4. Get JSON Schema

GET /api/rest/scArticles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.47.5. Get UI schema

GET /api/rest/scArticles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.47.6. Find by id

GET /api/rest/scArticles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.47.7. Update a resource

PUT /api/rest/scArticles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.47.8. Delete a resource

DELETE /api/rest/scArticles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.47.9. Patch (partially update) a resource

PATCH /api/rest/scArticles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.47.10. Find related by root id

GET /api/rest/scArticles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.47.11. Find related by root id

GET /api/rest/scArticles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.48. Sc Variable Values

Search or manage Sc Variable Value entries

2.48.1. Create a new HAL resource

POST /api/rest/scVariableValues
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.48.2. Search by ids

GET /api/rest/scVariableValues
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.48.3. Get CORS headers

OPTIONS /api/rest/scVariableValues
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.48.4. Get JSON Schema

GET /api/rest/scVariableValues/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.48.5. Get UI schema

GET /api/rest/scVariableValues/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.48.6. Find by id

GET /api/rest/scVariableValues/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.48.7. Update a resource

PUT /api/rest/scVariableValues/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.48.8. Delete a resource

DELETE /api/rest/scVariableValues/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.48.9. Patch (partially update) a resource

PATCH /api/rest/scVariableValues/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.48.10. Find related by root id

GET /api/rest/scVariableValues/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.48.11. Find related by root id

GET /api/rest/scVariableValues/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.49. Sc Variables

Search or manage Sc Variable entries

2.49.1. Create a new resource

POST /api/rest/scVariables
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.49.2. Search by ids

GET /api/rest/scVariables
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.49.3. Get CORS headers

OPTIONS /api/rest/scVariables
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.49.4. Get JSON Schema

GET /api/rest/scVariables/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.49.5. Get UI schema

GET /api/rest/scVariables/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.49.6. Find by id

GET /api/rest/scVariables/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.49.7. Update a resource

PUT /api/rest/scVariables/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.49.8. Delete a resource

DELETE /api/rest/scVariables/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.49.9. Patch (partially update) a resource

PATCH /api/rest/scVariables/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.49.10. Find related by root id

GET /api/rest/scVariables/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.49.11. Find related by root id

GET /api/rest/scVariables/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.50. Storage Urls

Search or manage Storage Url entries

2.50.1. Create a new HAL resource

POST /api/rest/storageUrls
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.50.2. Search by ids

GET /api/rest/storageUrls
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.50.3. Get CORS headers

OPTIONS /api/rest/storageUrls
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.50.4. Get JSON Schema

GET /api/rest/storageUrls/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.50.5. Get UI schema

GET /api/rest/storageUrls/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.50.6. Find by id

GET /api/rest/storageUrls/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.50.7. Update a resource

PUT /api/rest/storageUrls/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.50.8. Delete a resource

DELETE /api/rest/storageUrls/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.50.9. Patch (partially update) a resource

PATCH /api/rest/storageUrls/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.50.10. Find related by root id

GET /api/rest/storageUrls/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.50.11. Find related by root id

GET /api/rest/storageUrls/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.51. Surface Units

Search or manage Surface Unit entries

2.51.1. Create a new HAL resource

POST /api/rest/surfaceUnits
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.51.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/surfaceUnits
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.51.3. Get CORS headers

OPTIONS /api/rest/surfaceUnits
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.51.4. Get JSON Schema

GET /api/rest/surfaceUnits/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.51.5. Get UI schema

GET /api/rest/surfaceUnits/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.51.6. Find by id

GET /api/rest/surfaceUnits/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.51.7. Update a resource

PUT /api/rest/surfaceUnits/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.51.8. Delete a resource

DELETE /api/rest/surfaceUnits/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.51.9. Patch (partially update) a resource

PATCH /api/rest/surfaceUnits/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.51.10. Find related by root id

GET /api/rest/surfaceUnits/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.51.11. Find related by root id

GET /api/rest/surfaceUnits/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.52. Task Connection Types

Search or manage Task Connection Type entries

2.52.1. Create a new HAL resource

POST /api/rest/taskConnectionTypes
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.52.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/taskConnectionTypes
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.52.3. Get CORS headers

OPTIONS /api/rest/taskConnectionTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.52.4. Get JSON Schema

GET /api/rest/taskConnectionTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.52.5. Get UI schema

GET /api/rest/taskConnectionTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.52.6. Find by id

GET /api/rest/taskConnectionTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.52.7. Update a resource

PUT /api/rest/taskConnectionTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.52.8. Delete a resource

DELETE /api/rest/taskConnectionTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.52.9. Patch (partially update) a resource

PATCH /api/rest/taskConnectionTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.52.10. Find related by root id

GET /api/rest/taskConnectionTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.52.11. Find related by root id

GET /api/rest/taskConnectionTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.53. Task Locations

Search or manage Task Location entries

2.53.1. Create a new resource

POST /api/rest/taskLocations
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.53.2. Search by ids

GET /api/rest/taskLocations
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.53.3. Get CORS headers

OPTIONS /api/rest/taskLocations
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.53.4. Get JSON Schema

GET /api/rest/taskLocations/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.53.5. Get UI schema

GET /api/rest/taskLocations/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.53.6. Find by id

GET /api/rest/taskLocations/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.53.7. Update a resource

PUT /api/rest/taskLocations/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.53.8. Delete a resource

DELETE /api/rest/taskLocations/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.53.9. Patch (partially update) a resource

PATCH /api/rest/taskLocations/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.53.10. Find related by root id

GET /api/rest/taskLocations/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.53.11. Find related by root id

GET /api/rest/taskLocations/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.54. Task Roles

Search or manage Task Role entries

2.54.1. Create a new HAL resource

POST /api/rest/taskRoles
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.54.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/taskRoles
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.54.3. Get CORS headers

OPTIONS /api/rest/taskRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.54.4. Get JSON Schema

GET /api/rest/taskRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.54.5. Get UI schema

GET /api/rest/taskRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.54.6. Find by id

GET /api/rest/taskRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.54.7. Update a resource

PUT /api/rest/taskRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.54.8. Delete a resource

DELETE /api/rest/taskRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.54.9. Patch (partially update) a resource

PATCH /api/rest/taskRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.54.10. Find related by root id

GET /api/rest/taskRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.54.11. Find related by root id

GET /api/rest/taskRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.55. Task Trades

Search or manage Task Trade entries

2.55.1. Create a new HAL resource

POST /api/rest/taskTrades
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.55.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/taskTrades
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.55.3. Get CORS headers

OPTIONS /api/rest/taskTrades
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.55.4. Get JSON Schema

GET /api/rest/taskTrades/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.55.5. Get UI schema

GET /api/rest/taskTrades/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.55.6. Find by id

GET /api/rest/taskTrades/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.55.7. Update a resource

PUT /api/rest/taskTrades/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.55.8. Delete a resource

DELETE /api/rest/taskTrades/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.55.9. Patch (partially update) a resource

PATCH /api/rest/taskTrades/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.55.10. Find related by root id

GET /api/rest/taskTrades/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.55.11. Find related by root id

GET /api/rest/taskTrades/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.56. Task Types

Search or manage Task Type entries

2.56.1. Create a new resource

POST /api/rest/taskTypes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.56.2. Search by ids

GET /api/rest/taskTypes
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.56.3. Get CORS headers

OPTIONS /api/rest/taskTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.56.4. Get JSON Schema

GET /api/rest/taskTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.56.5. Get UI schema

GET /api/rest/taskTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.56.6. Find by id

GET /api/rest/taskTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.56.7. Update a resource

PUT /api/rest/taskTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.56.8. Delete a resource

DELETE /api/rest/taskTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.56.9. Patch (partially update) a resource

PATCH /api/rest/taskTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.56.10. Find related by root id

GET /api/rest/taskTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.56.11. Find related by root id

GET /api/rest/taskTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.57. Task User Roles

Search or manage Task User Role entries

2.57.1. Create a new HAL resource

POST /api/rest/taskUserRoles
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.57.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/taskUserRoles
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.57.3. Get CORS headers

OPTIONS /api/rest/taskUserRoles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.57.4. Get JSON Schema

GET /api/rest/taskUserRoles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.57.5. Get UI schema

GET /api/rest/taskUserRoles/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.57.6. Find by id

GET /api/rest/taskUserRoles/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.57.7. Update a resource

PUT /api/rest/taskUserRoles/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.57.8. Delete a resource

DELETE /api/rest/taskUserRoles/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.57.9. Patch (partially update) a resource

PATCH /api/rest/taskUserRoles/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.57.10. Find related by root id

GET /api/rest/taskUserRoles/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.57.11. Find related by root id

GET /api/rest/taskUserRoles/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.58. Task Work Log Types

Search or manage Task Work Log Type entries

2.58.1. Create a new resource

POST /api/rest/taskWorkLogTypes
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.58.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/taskWorkLogTypes
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.58.3. Get CORS headers

OPTIONS /api/rest/taskWorkLogTypes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.58.4. Get JSON Schema

GET /api/rest/taskWorkLogTypes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.58.5. Get UI schema

GET /api/rest/taskWorkLogTypes/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.58.6. Find by id

GET /api/rest/taskWorkLogTypes/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.58.7. Update a resource

PUT /api/rest/taskWorkLogTypes/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.58.8. Delete a resource

DELETE /api/rest/taskWorkLogTypes/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.58.9. Patch (partially update) a resource

PATCH /api/rest/taskWorkLogTypes/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.58.10. Find related by root id

GET /api/rest/taskWorkLogTypes/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.58.11. Find related by root id

GET /api/rest/taskWorkLogTypes/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.59. Task Work Logs

Search or manage Task Work Log entries

2.59.1. Create a new HAL resource

POST /api/rest/taskWorkLogs
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.59.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/taskWorkLogs
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.59.3. Get CORS headers

OPTIONS /api/rest/taskWorkLogs
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.59.4. Get JSON Schema

GET /api/rest/taskWorkLogs/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.59.5. Get UI schema

GET /api/rest/taskWorkLogs/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.59.6. Find by id

GET /api/rest/taskWorkLogs/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.59.7. Update a resource

PUT /api/rest/taskWorkLogs/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.59.8. Delete a resource

DELETE /api/rest/taskWorkLogs/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.59.9. Patch (partially update) a resource

PATCH /api/rest/taskWorkLogs/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.59.10. Find related by root id

GET /api/rest/taskWorkLogs/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.59.11. Find related by root id

GET /api/rest/taskWorkLogs/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.60. Tasks

Search or manage Task entries

2.60.1. Create a new HAL resource

POST /api/rest/tasks
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.60.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/tasks
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.60.3. Get CORS headers

OPTIONS /api/rest/tasks
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.60.4. Get JSON Schema

GET /api/rest/tasks/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.60.5. Get UI schema

GET /api/rest/tasks/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.60.6. Find by id

GET /api/rest/tasks/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.60.7. Update a resource

PUT /api/rest/tasks/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.60.8. Delete a resource

DELETE /api/rest/tasks/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.60.9. Patch (partially update) a resource

PATCH /api/rest/tasks/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.60.10. Find related by root id

GET /api/rest/tasks/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.60.11. Find related by root id

GET /api/rest/tasks/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.61. Tasks Connections

Search or manage Tasks Connection entries

2.61.1. Create a new HAL resource

POST /api/rest/tasksConnections
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.61.2. Search by ids

GET /api/rest/tasksConnections
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.61.3. Get CORS headers

OPTIONS /api/rest/tasksConnections
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.61.4. Get JSON Schema

GET /api/rest/tasksConnections/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.61.5. Get UI schema

GET /api/rest/tasksConnections/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.61.6. Find by id

GET /api/rest/tasksConnections/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.61.7. Update a resource

PUT /api/rest/tasksConnections/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.61.8. Delete a resource

DELETE /api/rest/tasksConnections/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.61.9. Patch (partially update) a resource

PATCH /api/rest/tasksConnections/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.61.10. Find related by root id

GET /api/rest/tasksConnections/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.61.11. Find related by root id

GET /api/rest/tasksConnections/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.62. Trades

Search or manage Trade entries

2.62.1. Create a new resource

POST /api/rest/trades
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.62.2. Search by ids

GET /api/rest/trades
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

ids
required

string

Query

ids[]
required

ids[]

< integer (int32) > array(multi)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.62.3. Get CORS headers

OPTIONS /api/rest/trades
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.62.4. Get JSON Schema

GET /api/rest/trades/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.62.5. Get UI schema

GET /api/rest/trades/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.62.6. Find by id

GET /api/rest/trades/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.62.7. Update a resource

PUT /api/rest/trades/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.62.8. Delete a resource

DELETE /api/rest/trades/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.62.9. Patch (partially update) a resource

PATCH /api/rest/trades/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.62.10. Find related by root id

GET /api/rest/trades/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.62.11. Find related by root id

GET /api/rest/trades/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.63. Types

Search or manage Type entries

2.63.1. Create a new HAL resource

POST /api/rest/types
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.63.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/types
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.63.3. Get CORS headers

OPTIONS /api/rest/types
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.63.4. Get JSON Schema

GET /api/rest/types/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.63.5. Get UI schema

GET /api/rest/types/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.63.6. Find by id

GET /api/rest/types/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.63.7. Update a resource

PUT /api/rest/types/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.63.8. Delete a resource

DELETE /api/rest/types/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.63.9. Patch (partially update) a resource

PATCH /api/rest/types/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.63.10. Find related by root id

GET /api/rest/types/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.63.11. Find related by root id

GET /api/rest/types/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.64. Variables

Search or manage Variable entries

2.64.1. Create a new HAL resource

POST /api/rest/variables
Parameters
Type Name Description Schema

Body

model
required

model

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.64.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/variables
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.64.3. Get CORS headers

OPTIONS /api/rest/variables
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.64.4. Get JSON Schema

GET /api/rest/variables/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.64.5. Get UI schema

GET /api/rest/variables/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.64.6. Find by id

GET /api/rest/variables/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.64.7. Update a resource

PUT /api/rest/variables/{id}
Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.64.8. Delete a resource

DELETE /api/rest/variables/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

string

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.64.9. Patch (partially update) a resource

PATCH /api/rest/variables/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

string

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.64.10. Find related by root id

GET /api/rest/variables/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.64.11. Find related by root id

GET /api/rest/variables/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.65. Volume Units

Search or manage Volume Unit entries

2.65.1. Create a new resource

POST /api/rest/volumeUnits
Parameters
Type Name Description Schema

Body

resource
required

resource

Responses
HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • */*

2.65.2. Search for resources (paginated).

GET /api/rest/volumeUnits
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.65.3. Get CORS headers

OPTIONS /api/rest/volumeUnits
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

  • application/vnd.api+json

Produces
  • application/json

  • application/vnd.api+json

2.65.4. Get JSON Schema

GET /api/rest/volumeUnits/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.65.5. Get UI schema

GET /api/rest/volumeUnits/uischema
Caution

operation.deprecated

Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Produces
  • application/json

2.65.6. Find by id

GET /api/rest/volumeUnits/{id}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

  • application/vnd.api+json

Produces
  • application/hal+json

  • application/vnd.api+json

2.65.7. Update a resource

PUT /api/rest/volumeUnits/{id}
Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.65.8. Delete a resource

DELETE /api/rest/volumeUnits/{id}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.65.9. Patch (partially update) a resource

PATCH /api/rest/volumeUnits/{id}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

id
required

string

integer (int32)

Body

model
required

model

Responses
HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/hal+json

Produces
  • application/hal+json

2.65.10. Find related by root id

GET /api/rest/volumeUnits/{id}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

2.65.11. Find related by root id

GET /api/rest/volumeUnits/{id}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

id
required

string

integer (int32)

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer (int32)

0

Query

_ps
optional

The page size

integer (int32)

10

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"id"

Responses
HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/vnd.api+json

Produces
  • application/vnd.api+json

3. Definitions

3.1. Article

Base auditable, disableable type with integer ID

Name Description Schema

amount
optional

integer (int32)

articleParent
optional

createdDate
optional
read-only

Date created

string (date-time)

id
optional

integer (int32)

information
optional

string

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

locked
optional

boolean

name
optional

string

picture
optional

string

scArticle
optional

unit
optional

string

3.2. ArticleProject

Name Schema

article
optional

currency
optional

disabled
optional

enterprise
optional

enterpriseType
optional

id
optional

integer (int32)

isFirm
optional

boolean

menge
optional

integer (int32)

offer
optional

price
optional

number

project
optional

requirement
optional

selected
optional

boolean

timestamp
optional

totalprice
optional

number

user
optional

3.3. ArticleProjectService

Name Schema

conversionService
optional

filePersistenceService
optional

3.4. ArticleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.5. BudgetUnit

Name Schema

id
optional

integer (int32)

name
optional

string

3.6. BudgetUnitService

Name Schema

conversionService
optional

filePersistenceService
optional

3.7. BuildingFmw

Name Schema

code
optional

string

disabled
optional

id
optional

integer (int32)

name
optional

string

parent
optional

referenceBuildingFramework
optional

3.8. BuildingFmwPhase

Name Schema

duration
optional

integer (int32)

endDate
optional

enterprise
optional

id
required

startDate
optional

status
optional

3.9. BuildingFmwPhasePK

A composite identifier (Project.id, BuildingFmw.id) used as ID in BuildingFmwPhase entities

Name Schema

left
required

right
required

3.10. BuildingFmwPhaseService

Name Schema

conversionService
optional

filePersistenceService
optional

3.11. BuildingFmwService

Name Schema

conversionService
optional

filePersistenceService
optional

3.12. BuildingFmwStatus

Name Schema

id
optional

integer (int32)

name
optional

string

3.13. BuildingFmwStatusService

Name Schema

conversionService
optional

filePersistenceService
optional

3.14. BuildingFmwTrade

Name Schema

id
required

3.15. BuildingFmwTradePK

A composite identifier (BuildingFmw.id, Trade.id) used as ID in BuildingFmwTrade entities

Name Schema

left
required

right
required

3.16. BuildingFmwTradeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.17. CatalogTree

Name Schema

catalog
optional

integer (int32)

code
optional

string

id
optional

integer (int32)

information
optional

string

name
optional

string

parent
optional

parentId
optional

integer (int32)

3.18. CatalogTreeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.19. CategoryEnterprise

Name Schema

categoryKey
optional

categoryValue
optional

string

enterprise
optional

id
optional

integer (int32)

3.20. CategoryEnterpriseService

Name Schema

conversionService
optional

filePersistenceService
optional

3.21. CategoryKey

Name Schema

id
optional

integer (int32)

keyName
optional

string

3.22. CategoryKeyService

Name Schema

conversionService
optional

filePersistenceService
optional

3.23. CategoryLocation

Name Schema

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

location
optional

3.24. CategoryLocationService

Name Schema

conversionService
optional

filePersistenceService
optional

3.25. CategoryProject

Name Schema

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

project
optional

3.26. CategoryProjectService

Name Schema

conversionService
optional

filePersistenceService
optional

3.27. CategoryStorageUrl

Name Schema

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

storageUrl
optional

type
optional

3.28. CategoryStorageUrlService

Name Schema

conversionService
optional

filePersistenceService
optional

3.29. CategoryTask

Name Schema

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

task
optional

3.30. CategoryTaskService

Name Schema

conversionService
optional

filePersistenceService
optional

3.31. CategoryUser

Name Schema

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

user
optional

3.32. CategoryUserService

Name Schema

conversionService
optional

filePersistenceService
optional

3.33. ChangePasswordForm

Name Schema

oldPassword
optional

string

password
optional

string

retypePassword
optional

string

3.34. Contract

Name Schema

id
optional

integer (int32)

name
optional

string

timestamp
optional

user
optional

3.35. ContractService

Name Schema

conversionService
optional

filePersistenceService
optional

3.36. ConversionService

Type : object

3.37. Country

Name Schema

id
optional

integer (int32)

name
optional

string

nationality
optional

string

3.38. CountryService

Name Schema

conversionService
optional

filePersistenceService
optional

3.39. Currency

Name Schema

id
optional

string

name
optional

string

3.40. CurrencyService

Name Schema

conversionService
optional

filePersistenceService
optional

3.41. Enterprise

Name Schema

address1
optional

string

address2
optional

string

city
optional

string

confirmedDate
optional

string (date)

confirmedUser
optional

country
optional

creationDate
optional

creationUser
optional

currency
optional

disabled
optional

string (date)

enterpriseEmail
optional

string

fax
optional

string

fiscalId
optional

string

iban
optional

string

id
optional

integer (int32)

legalType
optional

name
optional

string

numberOfEmployees
optional

phone
optional

string

picture
optional

string

plz
optional

string

registerScanDocUrl
optional

string

registerUrl
optional

string

slogan
optional

string

type
optional

vat
optional

string

webUrl
optional

string

3.42. EnterpriseLegalType

Name Schema

id
optional

integer (int32)

name
optional

string

3.43. EnterpriseLegalTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.44. EnterpriseRole

Name Schema

id
optional

integer (int32)

name
optional

string

3.45. EnterpriseRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.46. EnterpriseService

Name Schema

conversionService
optional

filePersistenceService
optional

3.47. EnterpriseTrade

Name Schema

id
required

3.48. EnterpriseTradePK

A composite identifier (Enterprise.id, Trade.id) used as ID in EnterpriseTrade entities

Name Schema

left
required

right
required

3.49. EnterpriseTradeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.50. EnterpriseType

Name Schema

id
optional

integer (int32)

name
optional

string

3.51. EnterpriseTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.52. EnterpriseUserRole

Name Schema

confirmed
optional

confirmedBy
optional

string

id
required

3.53. EnterpriseUserRolePK

A composite identifier of (Enterprise.id, User.id, EnterpriseRole.id) used as ID in EnterpriseUserRole entities

Name Schema

left
required

middle
required

right
required

3.54. EnterpriseUserRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.55. FilePersistenceService

Type : object

3.56. InvitedCoCo

Name Schema

creationUser
optional

disabled
optional

enterprise
optional

id
optional

integer (int32)

requirement
optional

timestamp
optional

trade
optional

3.57. InvitedCoCoService

Name Schema

conversionService
optional

filePersistenceService
optional

3.58. Iterable«ArticleProject»

Type : object

3.59. Iterable«Article»

Type : object

3.60. Iterable«BudgetUnit»

Type : object

3.61. Iterable«BuildingFmwPhase»

Type : object

3.62. Iterable«BuildingFmwStatus»

Type : object

3.63. Iterable«BuildingFmwTrade»

Type : object

3.64. Iterable«BuildingFmw»

Type : object

3.65. Iterable«CatalogTree»

Type : object

3.66. Iterable«CategoryEnterprise»

Type : object

3.67. Iterable«CategoryKey»

Type : object

3.68. Iterable«CategoryLocation»

Type : object

3.69. Iterable«CategoryProject»

Type : object

3.70. Iterable«CategoryStorageUrl»

Type : object

3.71. Iterable«CategoryTask»

Type : object

3.72. Iterable«CategoryUser»

Type : object

3.73. Iterable«Contract»

Type : object

3.74. Iterable«Country»

Type : object

3.75. Iterable«Currency»

Type : object

3.76. Iterable«EnterpriseLegalType»

Type : object

3.77. Iterable«EnterpriseRole»

Type : object

3.78. Iterable«EnterpriseTrade»

Type : object

3.79. Iterable«EnterpriseType»

Type : object

3.80. Iterable«EnterpriseUserRole»

Type : object

3.81. Iterable«Enterprise»

Type : object

3.82. Iterable«InvitedCoCo»

Type : object

3.83. Iterable«LangCode»

Type : object

3.84. Iterable«LocationRole»

Type : object

3.85. Iterable«LocationStatus»

Type : object

3.86. Iterable«LocationSubType»

Type : object

3.87. Iterable«LocationTrade»

Type : object

3.88. Iterable«LocationType»

Type : object

3.89. Iterable«LocationUserRole»

Type : object

3.90. Iterable«Location»

Type : object

3.91. Iterable«LogEntry»

Type : object

3.92. Iterable«NumWorkersOfEnterprise»

Type : object

3.93. Iterable«Offer»

Type : object

3.94. Iterable«ProjectEnterpriseCoCo»

Type : object

3.95. Iterable«ProjectEnterpriseNotCoCo»

Type : object

3.96. Iterable«ProjectRole»

Type : object

3.97. Iterable«ProjectStatus»

Type : object

3.98. Iterable«ProjectType»

Type : object

3.99. Iterable«ProjectUserRole»

Type : object

3.100. Iterable«Project»

Type : object

3.101. Iterable«ReferenceBuildingFramework»

Type : object

3.102. Iterable«Requirement»

Type : object

3.103. Iterable«ScArticle»

Type : object

3.104. Iterable«ScVariableValue»

Type : object

3.105. Iterable«ScVariable»

Type : object

3.106. Iterable«StorageUrl»

Type : object

3.107. Iterable«SurfaceUnit»

Type : object

3.108. Iterable«TaskConnectionType»

Type : object

3.109. Iterable«TaskLocation»

Type : object

3.110. Iterable«TaskRole»

Type : object

3.111. Iterable«TaskTrade»

Type : object

3.112. Iterable«TaskType»

Type : object

3.113. Iterable«TaskUserRole»

Type : object

3.114. Iterable«TaskWorkLogType»

Type : object

3.115. Iterable«TaskWorkLog»

Type : object

3.116. Iterable«TasksConnection»

Type : object

3.117. Iterable«Task»

Type : object

3.118. Iterable«Trade»

Type : object

3.119. Iterable«Type»

Type : object

3.120. Iterable«Variable»

Type : object

3.121. Iterable«VolumeUnit»

Type : object

3.122. JsonApiModelResourceCollectionDocument«Article,int»

Type : object

3.123. JsonApiModelResourceCollectionDocument«ArticleProject,int»

Type : object

3.124. JsonApiModelResourceCollectionDocument«BudgetUnit,int»

Type : object

3.125. JsonApiModelResourceCollectionDocument«BuildingFmw,int»

Type : object

3.126. JsonApiModelResourceCollectionDocument«BuildingFmwPhase,BuildingFmwPhasePK»

Type : object

3.127. JsonApiModelResourceCollectionDocument«BuildingFmwStatus,int»

Type : object

3.128. JsonApiModelResourceCollectionDocument«BuildingFmwTrade,BuildingFmwTradePK»

Type : object

3.129. JsonApiModelResourceCollectionDocument«CatalogTree,int»

Type : object

3.130. JsonApiModelResourceCollectionDocument«CategoryEnterprise,int»

Type : object

3.131. JsonApiModelResourceCollectionDocument«CategoryKey,int»

Type : object

3.132. JsonApiModelResourceCollectionDocument«CategoryLocation,int»

Type : object

3.133. JsonApiModelResourceCollectionDocument«CategoryProject,int»

Type : object

3.134. JsonApiModelResourceCollectionDocument«CategoryStorageUrl,int»

Type : object

3.135. JsonApiModelResourceCollectionDocument«CategoryTask,int»

Type : object

3.136. JsonApiModelResourceCollectionDocument«CategoryUser,int»

Type : object

3.137. JsonApiModelResourceCollectionDocument«Contract,int»

Type : object

3.138. JsonApiModelResourceCollectionDocument«Country,int»

Type : object

3.139. JsonApiModelResourceCollectionDocument«Currency,string»

Type : object

3.140. JsonApiModelResourceCollectionDocument«Enterprise,int»

Type : object

3.141. JsonApiModelResourceCollectionDocument«EnterpriseLegalType,int»

Type : object

3.142. JsonApiModelResourceCollectionDocument«EnterpriseRole,int»

Type : object

3.143. JsonApiModelResourceCollectionDocument«EnterpriseTrade,EnterpriseTradePK»

Type : object

3.144. JsonApiModelResourceCollectionDocument«EnterpriseType,int»

Type : object

3.145. JsonApiModelResourceCollectionDocument«EnterpriseUserRole,EnterpriseUserRolePK»

Type : object

3.146. JsonApiModelResourceCollectionDocument«InvitedCoCo,int»

Type : object

3.147. JsonApiModelResourceCollectionDocument«LangCode,string»

Type : object

3.148. JsonApiModelResourceCollectionDocument«Location,int»

Type : object

3.149. JsonApiModelResourceCollectionDocument«LocationRole,int»

Type : object

3.150. JsonApiModelResourceCollectionDocument«LocationStatus,int»

Type : object

3.151. JsonApiModelResourceCollectionDocument«LocationSubType,int»

Type : object

3.152. JsonApiModelResourceCollectionDocument«LocationTrade,LocationTradePK»

Type : object

3.153. JsonApiModelResourceCollectionDocument«LocationType,int»

Type : object

3.154. JsonApiModelResourceCollectionDocument«LocationUserRole,int»

Type : object

3.155. JsonApiModelResourceCollectionDocument«LogEntry,int»

Type : object

3.156. JsonApiModelResourceCollectionDocument«NumWorkersOfEnterprise,int»

Type : object

3.157. JsonApiModelResourceCollectionDocument«Offer,int»

Type : object

3.158. JsonApiModelResourceCollectionDocument«Project,int»

Type : object

3.159. JsonApiModelResourceCollectionDocument«ProjectEnterpriseCoCo,ProjectEnterpriseCoCoPK»

Type : object

3.160. JsonApiModelResourceCollectionDocument«ProjectEnterpriseNotCoCo,ProjectEnterpriseNotCoCoPK»

Type : object

3.161. JsonApiModelResourceCollectionDocument«ProjectRole,int»

Type : object

3.162. JsonApiModelResourceCollectionDocument«ProjectStatus,int»

Type : object

3.163. JsonApiModelResourceCollectionDocument«ProjectType,int»

Type : object

3.164. JsonApiModelResourceCollectionDocument«ProjectUserRole,ProjectUserRolePK»

Type : object

3.165. JsonApiModelResourceCollectionDocument«ReferenceBuildingFramework,int»

Type : object

3.166. JsonApiModelResourceCollectionDocument«Requirement,int»

Type : object

3.167. JsonApiModelResourceCollectionDocument«ScArticle,int»

Type : object

3.168. JsonApiModelResourceCollectionDocument«ScVariable,int»

Type : object

3.169. JsonApiModelResourceCollectionDocument«ScVariableValue,int»

Type : object

3.170. JsonApiModelResourceCollectionDocument«StorageUrl,int»

Type : object

3.171. JsonApiModelResourceCollectionDocument«SurfaceUnit,int»

Type : object

3.172. JsonApiModelResourceCollectionDocument«Task,int»

Type : object

3.173. JsonApiModelResourceCollectionDocument«TaskConnectionType,int»

Type : object

3.174. JsonApiModelResourceCollectionDocument«TaskLocation,TaskLocationPK»

Type : object

3.175. JsonApiModelResourceCollectionDocument«TaskRole,int»

Type : object

3.176. JsonApiModelResourceCollectionDocument«TaskTrade,TaskTradePK»

Type : object

3.177. JsonApiModelResourceCollectionDocument«TaskType,int»

Type : object

3.178. JsonApiModelResourceCollectionDocument«TaskUserRole,int»

Type : object

3.179. JsonApiModelResourceCollectionDocument«TaskWorkLog,int»

Type : object

3.180. JsonApiModelResourceCollectionDocument«TaskWorkLogType,int»

Type : object

3.181. JsonApiModelResourceCollectionDocument«TasksConnection,TasksConnectionPK»

Type : object

3.182. JsonApiModelResourceCollectionDocument«Trade,int»

Type : object

3.183. JsonApiModelResourceCollectionDocument«Type,int»

Type : object

3.184. JsonApiModelResourceCollectionDocument«Variable,VariablePK»

Type : object

3.185. JsonApiModelResourceCollectionDocument«VolumeUnit,int»

Type : object

3.186. JsonApiModelResourceDocument«Article,int»

Type : object

3.187. JsonApiModelResourceDocument«ArticleProject,int»

Type : object

3.188. JsonApiModelResourceDocument«BudgetUnit,int»

Type : object

3.189. JsonApiModelResourceDocument«BuildingFmw,int»

Type : object

3.190. JsonApiModelResourceDocument«BuildingFmwPhase,BuildingFmwPhasePK»

Type : object

3.191. JsonApiModelResourceDocument«BuildingFmwStatus,int»

Type : object

3.192. JsonApiModelResourceDocument«BuildingFmwTrade,BuildingFmwTradePK»

Type : object

3.193. JsonApiModelResourceDocument«CatalogTree,int»

Type : object

3.194. JsonApiModelResourceDocument«CategoryEnterprise,int»

Type : object

3.195. JsonApiModelResourceDocument«CategoryKey,int»

Type : object

3.196. JsonApiModelResourceDocument«CategoryLocation,int»

Type : object

3.197. JsonApiModelResourceDocument«CategoryProject,int»

Type : object

3.198. JsonApiModelResourceDocument«CategoryStorageUrl,int»

Type : object

3.199. JsonApiModelResourceDocument«CategoryTask,int»

Type : object

3.200. JsonApiModelResourceDocument«CategoryUser,int»

Type : object

3.201. JsonApiModelResourceDocument«Contract,int»

Type : object

3.202. JsonApiModelResourceDocument«Country,int»

Type : object

3.203. JsonApiModelResourceDocument«Currency,string»

Type : object

3.204. JsonApiModelResourceDocument«Enterprise,int»

Type : object

3.205. JsonApiModelResourceDocument«EnterpriseLegalType,int»

Type : object

3.206. JsonApiModelResourceDocument«EnterpriseRole,int»

Type : object

3.207. JsonApiModelResourceDocument«EnterpriseTrade,EnterpriseTradePK»

Type : object

3.208. JsonApiModelResourceDocument«EnterpriseType,int»

Type : object

3.209. JsonApiModelResourceDocument«EnterpriseUserRole,EnterpriseUserRolePK»

Type : object

3.210. JsonApiModelResourceDocument«InvitedCoCo,int»

Type : object

3.211. JsonApiModelResourceDocument«LangCode,string»

Type : object

3.212. JsonApiModelResourceDocument«Location,int»

Type : object

3.213. JsonApiModelResourceDocument«LocationRole,int»

Type : object

3.214. JsonApiModelResourceDocument«LocationStatus,int»

Type : object

3.215. JsonApiModelResourceDocument«LocationSubType,int»

Type : object

3.216. JsonApiModelResourceDocument«LocationTrade,LocationTradePK»

Type : object

3.217. JsonApiModelResourceDocument«LocationType,int»

Type : object

3.218. JsonApiModelResourceDocument«LocationUserRole,int»

Type : object

3.219. JsonApiModelResourceDocument«LogEntry,int»

Type : object

3.220. JsonApiModelResourceDocument«NumWorkersOfEnterprise,int»

Type : object

3.221. JsonApiModelResourceDocument«Offer,int»

Type : object

3.222. JsonApiModelResourceDocument«Project,int»

Type : object

3.223. JsonApiModelResourceDocument«ProjectEnterpriseCoCo,ProjectEnterpriseCoCoPK»

Type : object

3.224. JsonApiModelResourceDocument«ProjectEnterpriseNotCoCo,ProjectEnterpriseNotCoCoPK»

Type : object

3.225. JsonApiModelResourceDocument«ProjectRole,int»

Type : object

3.226. JsonApiModelResourceDocument«ProjectStatus,int»

Type : object

3.227. JsonApiModelResourceDocument«ProjectType,int»

Type : object

3.228. JsonApiModelResourceDocument«ProjectUserRole,ProjectUserRolePK»

Type : object

3.229. JsonApiModelResourceDocument«ReferenceBuildingFramework,int»

Type : object

3.230. JsonApiModelResourceDocument«Requirement,int»

Type : object

3.231. JsonApiModelResourceDocument«ScArticle,int»

Type : object

3.232. JsonApiModelResourceDocument«ScVariable,int»

Type : object

3.233. JsonApiModelResourceDocument«ScVariableValue,int»

Type : object

3.234. JsonApiModelResourceDocument«StorageUrl,int»

Type : object

3.235. JsonApiModelResourceDocument«SurfaceUnit,int»

Type : object

3.236. JsonApiModelResourceDocument«Task,int»

Type : object

3.237. JsonApiModelResourceDocument«TaskConnectionType,int»

Type : object

3.238. JsonApiModelResourceDocument«TaskLocation,TaskLocationPK»

Type : object

3.239. JsonApiModelResourceDocument«TaskRole,int»

Type : object

3.240. JsonApiModelResourceDocument«TaskTrade,TaskTradePK»

Type : object

3.241. JsonApiModelResourceDocument«TaskType,int»

Type : object

3.242. JsonApiModelResourceDocument«TaskUserRole,int»

Type : object

3.243. JsonApiModelResourceDocument«TaskWorkLog,int»

Type : object

3.244. JsonApiModelResourceDocument«TaskWorkLogType,int»

Type : object

3.245. JsonApiModelResourceDocument«TasksConnection,TasksConnectionPK»

Type : object

3.246. JsonApiModelResourceDocument«Trade,int»

Type : object

3.247. JsonApiModelResourceDocument«Type,int»

Type : object

3.248. JsonApiModelResourceDocument«Variable,VariablePK»

Type : object

3.249. JsonApiModelResourceDocument«VolumeUnit,int»

Type : object

3.250. LangCode

Name Schema

id
optional

string

name
optional

string

3.251. LangCodeService

Name Schema

conversionService
optional

filePersistenceService
optional

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

rel
optional

string

templated
optional

boolean

title
optional

string

type
optional

string

3.253. Location

Base auditable, disableable type with integer ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

defaultImage
optional

defaultPlan
optional

description
optional

string

endDate
optional

string (date-time)

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

order
optional

integer (int32)

parent
optional

project
optional

starred
optional

boolean

startDate
optional

string (date-time)

status
optional

subType
optional

surface
optional

number

surfaceUnit
optional

type
optional

volume
optional

number

volumeUnit
optional

3.254. LocationRole

Name Schema

id
optional

integer (int32)

role
optional

string

3.255. LocationRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.256. LocationService

Name Schema

conversionService
optional

filePersistenceService
optional

3.257. LocationStatus

Name Schema

id
optional

integer (int32)

name
optional

string

3.258. LocationStatusService

Name Schema

conversionService
optional

filePersistenceService
optional

3.259. LocationSubType

Name Schema

id
optional

integer (int32)

mainLocationType
optional

name
optional

string

3.260. LocationSubTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.261. LocationTrade

Base auditable, disableable type with composite ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional
read-only

Date disabled

string (date-time)

id
required

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

trade
optional

3.262. LocationTradePK

A composite identifier (Location.id, Trade.id) used in LocationTrade entities

Name Schema

left
required

right
required

3.263. LocationTradeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.264. LocationType

Name Schema

id
optional

integer (int32)

name
optional

string

parent
optional

3.265. LocationTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.266. LocationUserRole

Base auditable, disableable type with integer ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

enterprise
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

location
optional

role
optional

user
optional

3.267. LocationUserRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.268. LogEntry

Name Schema

date
optional

id
optional

integer (int32)

logline
optional

string

3.269. LogEntryService

Name Schema

conversionService
optional

filePersistenceService
optional

3.270. NumWorkersOfEnterprise

Name Schema

id
optional

integer (int32)

label
optional

string

maxWorkers
optional

integer (int32)

minWorkers
optional

integer (int32)

3.271. NumWorkersOfEnterpriseService

Name Schema

conversionService
optional

filePersistenceService
optional

3.272. Offer

Name Schema

coCo
optional

contract
optional

disabled
optional

discount1
optional

number

discountWithin10Days
optional

number

expiryDate
optional

string (date-time)

generalDeductions
optional

number

id
optional

integer (int32)

investor
optional

message
optional

string

name
optional

string

project
optional

requirement
optional

subTotal1
optional

number

subTotal2
optional

number

subTotal3
optional

number

subject
optional

string

timestamp
optional

total
optional

number

totalSum
optional

number

trade
optional

user
optional

vat
optional

number

3.273. OfferService

Name Schema

conversionService
optional

filePersistenceService
optional

3.274. Pageable

Name Schema

offset
optional

integer (int64)

pageNumber
optional

integer (int32)

pageSize
optional

integer (int32)

paged
optional

boolean

sort
optional

unpaged
optional

boolean

3.275. ParamsAwarePageImpl«ArticleProject»

Name Schema

content
optional

< ArticleProject > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.276. ParamsAwarePageImpl«Article»

Name Schema

content
optional

< Article > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.277. ParamsAwarePageImpl«BudgetUnit»

Name Schema

content
optional

< BudgetUnit > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.278. ParamsAwarePageImpl«BuildingFmwPhase»

Name Schema

content
optional

< BuildingFmwPhase > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.279. ParamsAwarePageImpl«BuildingFmwStatus»

Name Schema

content
optional

< BuildingFmwStatus > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.280. ParamsAwarePageImpl«BuildingFmwTrade»

Name Schema

content
optional

< BuildingFmwTrade > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.281. ParamsAwarePageImpl«BuildingFmw»

Name Schema

content
optional

< BuildingFmw > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.282. ParamsAwarePageImpl«CatalogTree»

Name Schema

content
optional

< CatalogTree > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.283. ParamsAwarePageImpl«CategoryEnterprise»

Name Schema

content
optional

< CategoryEnterprise > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.284. ParamsAwarePageImpl«CategoryKey»

Name Schema

content
optional

< CategoryKey > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.285. ParamsAwarePageImpl«CategoryLocation»

Name Schema

content
optional

< CategoryLocation > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.286. ParamsAwarePageImpl«CategoryProject»

Name Schema

content
optional

< CategoryProject > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.287. ParamsAwarePageImpl«CategoryStorageUrl»

Name Schema

content
optional

< CategoryStorageUrl > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.288. ParamsAwarePageImpl«CategoryTask»

Name Schema

content
optional

< CategoryTask > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.289. ParamsAwarePageImpl«CategoryUser»

Name Schema

content
optional

< CategoryUser > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.290. ParamsAwarePageImpl«Contract»

Name Schema

content
optional

< Contract > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.291. ParamsAwarePageImpl«Country»

Name Schema

content
optional

< Country > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.292. ParamsAwarePageImpl«Currency»

Name Schema

content
optional

< Currency > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.293. ParamsAwarePageImpl«EnterpriseLegalType»

Name Schema

content
optional

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.294. ParamsAwarePageImpl«EnterpriseRole»

Name Schema

content
optional

< EnterpriseRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.295. ParamsAwarePageImpl«EnterpriseTrade»

Name Schema

content
optional

< EnterpriseTrade > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.296. ParamsAwarePageImpl«EnterpriseType»

Name Schema

content
optional

< EnterpriseType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.297. ParamsAwarePageImpl«EnterpriseUserRole»

Name Schema

content
optional

< EnterpriseUserRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.298. ParamsAwarePageImpl«Enterprise»

Name Schema

content
optional

< Enterprise > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.299. ParamsAwarePageImpl«InvitedCoCo»

Name Schema

content
optional

< InvitedCoCo > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.300. ParamsAwarePageImpl«LangCode»

Name Schema

content
optional

< LangCode > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.301. ParamsAwarePageImpl«LocationRole»

Name Schema

content
optional

< LocationRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.302. ParamsAwarePageImpl«LocationStatus»

Name Schema

content
optional

< LocationStatus > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.303. ParamsAwarePageImpl«LocationSubType»

Name Schema

content
optional

< LocationSubType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.304. ParamsAwarePageImpl«LocationTrade»

Name Schema

content
optional

< LocationTrade > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.305. ParamsAwarePageImpl«LocationType»

Name Schema

content
optional

< LocationType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.306. ParamsAwarePageImpl«LocationUserRole»

Name Schema

content
optional

< LocationUserRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.307. ParamsAwarePageImpl«Location»

Name Schema

content
optional

< Location > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.308. ParamsAwarePageImpl«LogEntry»

Name Schema

content
optional

< LogEntry > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.309. ParamsAwarePageImpl«NumWorkersOfEnterprise»

Name Schema

content
optional

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.310. ParamsAwarePageImpl«Offer»

Name Schema

content
optional

< Offer > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.311. ParamsAwarePageImpl«ProjectEnterpriseCoCo»

Name Schema

content
optional

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.312. ParamsAwarePageImpl«ProjectEnterpriseNotCoCo»

Name Schema

content
optional

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.313. ParamsAwarePageImpl«ProjectRole»

Name Schema

content
optional

< ProjectRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.314. ParamsAwarePageImpl«ProjectStatus»

Name Schema

content
optional

< ProjectStatus > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.315. ParamsAwarePageImpl«ProjectType»

Name Schema

content
optional

< ProjectType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.316. ParamsAwarePageImpl«ProjectUserRole»

Name Schema

content
optional

< ProjectUserRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.317. ParamsAwarePageImpl«Project»

Name Schema

content
optional

< Project > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.318. ParamsAwarePageImpl«ReferenceBuildingFramework»

Name Schema

content
optional

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.319. ParamsAwarePageImpl«Requirement»

Name Schema

content
optional

< Requirement > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.320. ParamsAwarePageImpl«ScArticle»

Name Schema

content
optional

< ScArticle > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.321. ParamsAwarePageImpl«ScVariableValue»

Name Schema

content
optional

< ScVariableValue > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.322. ParamsAwarePageImpl«ScVariable»

Name Schema

content
optional

< ScVariable > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.323. ParamsAwarePageImpl«StorageUrl»

Name Schema

content
optional

< StorageUrl > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.324. ParamsAwarePageImpl«SurfaceUnit»

Name Schema

content
optional

< SurfaceUnit > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.325. ParamsAwarePageImpl«TaskConnectionType»

Name Schema

content
optional

< TaskConnectionType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.326. ParamsAwarePageImpl«TaskLocation»

Name Schema

content
optional

< TaskLocation > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.327. ParamsAwarePageImpl«TaskRole»

Name Schema

content
optional

< TaskRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.328. ParamsAwarePageImpl«TaskTrade»

Name Schema

content
optional

< TaskTrade > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.329. ParamsAwarePageImpl«TaskType»

Name Schema

content
optional

< TaskType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.330. ParamsAwarePageImpl«TaskUserRole»

Name Schema

content
optional

< TaskUserRole > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.331. ParamsAwarePageImpl«TaskWorkLogType»

Name Schema

content
optional

< TaskWorkLogType > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.332. ParamsAwarePageImpl«TaskWorkLog»

Name Schema

content
optional

< TaskWorkLog > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.333. ParamsAwarePageImpl«TasksConnection»

Name Schema

content
optional

< TasksConnection > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.334. ParamsAwarePageImpl«Task»

Name Schema

content
optional

< Task > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.335. ParamsAwarePageImpl«Trade»

Name Schema

content
optional

< Trade > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.336. ParamsAwarePageImpl«Type»

Name Schema

content
optional

< Type > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.337. ParamsAwarePageImpl«Variable»

Name Schema

content
optional

< Variable > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.338. ParamsAwarePageImpl«VolumeUnit»

Name Schema

content
optional

< VolumeUnit > array

empty
optional

boolean

first
optional

boolean

last
optional

boolean

number
optional

integer (int32)

numberOfElements
optional

integer (int32)

pageable
optional

parameters
optional

< string, < string > array > map

size
optional

integer (int32)

sort
optional

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

3.339. Project

Base auditable, disableable type with integer ID

Name Description Schema

cachedData
optional

string

city
optional

string

code
optional

string

country
optional

string

createdDate
optional
read-only

Date created

string (date-time)

defaultImage
optional

description
optional

string

endDate
optional

string (date-time)

id
optional

integer (int32)

internalId
optional

string

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

starred
optional

boolean

startDate
optional

string (date-time)

status
optional

street
optional

string

type
optional

website
optional

string

3.340. ProjectEnterpriseCoCo

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

id
required

representative
optional

3.341. ProjectEnterpriseCoCoPK

A composite identifier of (Enterprise.id, Project.id, EnterpriseType.id, Trade.id) used as ID in ProjectEnterpriseCoCo entities

Name Schema

innerLeft
required

innerRight
required

left
required

right
required

3.342. ProjectEnterpriseCoCoService

Name Schema

conversionService
optional

filePersistenceService
optional

3.343. ProjectEnterpriseNotCoCo

Name Schema

createdDate
optional

string (date-time)

id
required

representative
optional

3.344. ProjectEnterpriseNotCoCoPK

A composite identifier of (Enterprise.id, Project.id, EnterpriseType.id)

Name Schema

left
required

middle
required

right
required

3.345. ProjectEnterpriseNotCoCoService

Name Schema

conversionService
optional

filePersistenceService
optional

3.346. ProjectRole

Name Schema

id
optional

integer (int32)

name
optional

string

3.347. ProjectRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.348. ProjectService

Name Schema

conversionService
optional

filePersistenceService
optional

3.349. ProjectStatus

Name Schema

id
optional

integer (int32)

name
optional

string

3.350. ProjectStatusService

Name Schema

conversionService
optional

filePersistenceService
optional

3.351. ProjectType

Name Schema

id
optional

integer (int32)

name
optional

string

3.352. ProjectTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.353. ProjectUserRole

Name Schema

disabled
optional

string (date-time)

id
required

3.354. ProjectUserRolePK

A composite identifier (Project.id, User.id, Projectrole.id) used in ProjectUser entities

Name Schema

left
required

middle
required

right
required

3.355. ProjectUserRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.356. RawJson

Type : object

3.357. ReferenceBuildingFramework

Name Schema

country
optional

id
optional

integer (int32)

3.358. ReferenceBuildingFrameworkService

Name Schema

conversionService
optional

filePersistenceService
optional

3.359. Requirement

Name Schema

disabled
optional

expiryDate
optional

id
optional

integer (int32)

investor
optional

message
optional

string

name
optional

string

project
optional

subject
optional

string

timestamp
optional

user
optional

3.360. RequirementService

Name Schema

conversionService
optional

filePersistenceService
optional

3.361. ResetPasswordForm

Name Schema

code
optional

string

newPassword
optional

string

3.362. Resource«ArticleProject»

Name Schema

_links
optional

< Link > array

article
optional

currency
optional

disabled
optional

enterprise
optional

enterpriseType
optional

id
optional

integer (int32)

isFirm
optional

boolean

menge
optional

integer (int32)

offer
optional

price
optional

number

project
optional

requirement
optional

selected
optional

boolean

timestamp
optional

totalprice
optional

number

user
optional

3.363. Resource«Article»

Name Description Schema

_links
optional

< Link > array

amount
optional

integer (int32)

articleParent
optional

createdDate
optional
read-only

Date created

string (date-time)

id
optional

integer (int32)

information
optional

string

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

locked
optional

boolean

name
optional

string

picture
optional

string

scArticle
optional

unit
optional

string

3.364. Resource«BudgetUnit»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.365. Resource«BuildingFmwPhase»

Name Schema

_links
optional

< Link > array

duration
optional

integer (int32)

endDate
optional

enterprise
optional

id
required

startDate
optional

status
optional

3.366. Resource«BuildingFmwStatus»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.367. Resource«BuildingFmwTrade»

Name Schema

_links
optional

< Link > array

id
required

3.368. Resource«BuildingFmw»

Name Schema

_links
optional

< Link > array

code
optional

string

disabled
optional

id
optional

integer (int32)

name
optional

string

referenceBuildingFramework
optional

3.369. Resource«CatalogTree»

Name Schema

_links
optional

< Link > array

catalog
optional

integer (int32)

code
optional

string

id
optional

integer (int32)

information
optional

string

name
optional

string

parentId
optional

integer (int32)

3.370. Resource«CategoryEnterprise»

Name Schema

_links
optional

< Link > array

categoryKey
optional

categoryValue
optional

string

enterprise
optional

id
optional

integer (int32)

3.371. Resource«CategoryKey»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

keyName
optional

string

3.372. Resource«CategoryLocation»

Name Schema

_links
optional

< Link > array

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

location
optional

3.373. Resource«CategoryProject»

Name Schema

_links
optional

< Link > array

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

project
optional

3.374. Resource«CategoryStorageUrl»

Name Schema

_links
optional

< Link > array

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

storageUrl
optional

type
optional

3.375. Resource«CategoryTask»

Name Schema

_links
optional

< Link > array

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

task
optional

3.376. Resource«CategoryUser»

Name Schema

_links
optional

< Link > array

categoryKey
optional

categoryValue
optional

string

id
optional

integer (int32)

user
optional

3.377. Resource«Contract»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

timestamp
optional

user
optional

3.378. Resource«Country»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

nationality
optional

string

3.379. Resource«Currency»

Name Schema

_links
optional

< Link > array

id
optional

string

name
optional

string

3.380. Resource«EnterpriseLegalType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.381. Resource«EnterpriseRole»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.382. Resource«EnterpriseTrade»

Name Schema

_links
optional

< Link > array

id
required

3.383. Resource«EnterpriseType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.384. Resource«EnterpriseUserRole»

Name Schema

_links
optional

< Link > array

confirmed
optional

confirmedBy
optional

string

id
required

3.385. Resource«Enterprise»

Name Schema

_links
optional

< Link > array

address1
optional

string

address2
optional

string

city
optional

string

confirmedDate
optional

string (date)

confirmedUser
optional

country
optional

creationDate
optional

creationUser
optional

currency
optional

disabled
optional

string (date)

enterpriseEmail
optional

string

fax
optional

string

fiscalId
optional

string

iban
optional

string

id
optional

integer (int32)

legalType
optional

name
optional

string

numberOfEmployees
optional

phone
optional

string

picture
optional

string

plz
optional

string

registerScanDocUrl
optional

string

registerUrl
optional

string

slogan
optional

string

type
optional

vat
optional

string

webUrl
optional

string

3.386. Resource«InvitedCoCo»

Name Schema

_links
optional

< Link > array

creationUser
optional

disabled
optional

enterprise
optional

id
optional

integer (int32)

requirement
optional

timestamp
optional

trade
optional

3.387. Resource«LangCode»

Name Schema

_links
optional

< Link > array

id
optional

string

name
optional

string

3.388. Resource«LocationRole»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

role
optional

string

3.389. Resource«LocationStatus»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.390. Resource«LocationSubType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

mainLocationType
optional

name
optional

string

3.391. Resource«LocationTrade»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional
read-only

Date disabled

string (date-time)

id
required

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

trade
optional

3.392. Resource«LocationType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.393. Resource«LocationUserRole»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

enterprise
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

location
optional

role
optional

user
optional

3.394. Resource«Location»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

defaultImage
optional

defaultPlan
optional

description
optional

string

endDate
optional

string (date-time)

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

order
optional

integer (int32)

project
optional

starred
optional

boolean

startDate
optional

string (date-time)

status
optional

subType
optional

surface
optional

number

surfaceUnit
optional

type
optional

volume
optional

number

volumeUnit
optional

3.395. Resource«LogEntry»

Name Schema

_links
optional

< Link > array

date
optional

id
optional

integer (int32)

logline
optional

string

3.396. Resource«NumWorkersOfEnterprise»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

label
optional

string

maxWorkers
optional

integer (int32)

minWorkers
optional

integer (int32)

3.397. Resource«Offer»

Name Schema

_links
optional

< Link > array

coCo
optional

contract
optional

disabled
optional

discount1
optional

number

discountWithin10Days
optional

number

expiryDate
optional

string (date-time)

generalDeductions
optional

number

id
optional

integer (int32)

investor
optional

message
optional

string

name
optional

string

project
optional

requirement
optional

subTotal1
optional

number

subTotal2
optional

number

subTotal3
optional

number

subject
optional

string

timestamp
optional

total
optional

number

totalSum
optional

number

trade
optional

user
optional

vat
optional

number

3.398. Resource«ProjectEnterpriseCoCo»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

id
required

representative
optional

3.399. Resource«ProjectEnterpriseNotCoCo»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

id
required

representative
optional

3.400. Resource«ProjectRole»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.401. Resource«ProjectStatus»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.402. Resource«ProjectType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.403. Resource«ProjectUserRole»

Name Description Schema

_links
optional

< Link > array

disabled
optional
read-only

Date disabled

string (date-time)

id
required

3.404. Resource«Project»

Name Description Schema

_links
optional

< Link > array

cachedData
optional

string

city
optional

string

code
optional

string

country
optional

string

createdDate
optional
read-only

Date created

string (date-time)

defaultImage
optional

description
optional

string

endDate
optional

string (date-time)

id
optional

integer (int32)

internalId
optional

string

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

starred
optional

boolean

startDate
optional

string (date-time)

status
optional

street
optional

string

type
optional

website
optional

string

3.405. Resource«ReferenceBuildingFramework»

Name Schema

_links
optional

< Link > array

country
optional

id
optional

integer (int32)

3.406. Resource«Requirement»

Name Schema

_links
optional

< Link > array

disabled
optional

expiryDate
optional

id
optional

integer (int32)

investor
optional

message
optional

string

name
optional

string

project
optional

subject
optional

string

timestamp
optional

user
optional

3.407. Resource«ScArticle»

Name Schema

_links
optional

< Link > array

amount
optional

number

catalogTree
optional

disabled
optional

id
optional

integer (int32)

information
optional

string

name
optional

string

position
optional

string

unit
optional

string

3.408. Resource«ScVariableValue»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

pos
optional

integer (int32)

scVariable
optional

value
optional

string

3.409. Resource«ScVariable»

Name Schema

_links
optional

< Link > array

disabled
optional

id
optional

integer (int32)

name
optional

string

scArticle
optional

3.410. Resource«StorageUrl»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

length
optional

integer (int64)

mimeType
optional

string

url
optional

string

urlMediumImage
optional

string

urlSmallImage
optional

string

3.411. Resource«SurfaceUnit»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.412. Resource«TaskConnectionType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.413. Resource«TaskLocation»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional
read-only

Date disabled

string (date-time)

id
required

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

3.414. Resource«TaskRole»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.415. Resource«TaskTrade»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional
read-only

Date disabled

string (date-time)

id
required

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

3.416. Resource«TaskType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.417. Resource«TaskUserRole»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

enterprise
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

role
optional

task
optional

used
optional

3.418. Resource«TaskWorkLogType»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

isStartType
optional

boolean

name
optional

string

3.419. Resource«TaskWorkLog»

Name Description Schema

_links
optional

< Link > array

attachment
optional

createdDate
optional
read-only

Date created

string (date-time)

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

message
optional

string

reporter
optional

task
optional

timestamp
optional

trade
optional

type
optional

3.420. Resource«TasksConnection»

Name Description Schema

_links
optional

< Link > array

comment
optional

string

connectionType
optional

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional
read-only

Date disabled

string (date-time)

id
required

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

3.421. Resource«Task»

Name Description Schema

_links
optional

< Link > array

blocked
optional

integer (int32)

budget
optional

integer (int32)

buffer
optional

integer (int32)

createdDate
optional
read-only

Date created

string (date-time)

dateFrom
optional

dateTo
optional

description
optional

string

enterprise
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

order
optional

integer (int32)

project
optional

starred
optional

boolean

status
optional

type
optional

unitBlocked
optional

unitBudget
optional

unitBuffer
optional

3.422. Resource«Trade»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

selectable
optional

boolean

3.423. Resource«Type»

Name Description Schema

_links
optional

< Link > array

createdDate
optional
read-only

Date created

string (date-time)

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

3.424. Resource«Variable»

Name Schema

_links
optional

< Link > array

id
required

pos
optional

integer (int32)

scVariable
optional

3.425. Resource«VolumeUnit»

Name Schema

_links
optional

< Link > array

id
optional

integer (int32)

name
optional

string

3.426. ResponseEntity«ArticleProject»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.427. ResponseEntity«Article»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.428. ResponseEntity«BudgetUnit»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.429. ResponseEntity«BuildingFmwPhase»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.430. ResponseEntity«BuildingFmwStatus»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.431. ResponseEntity«BuildingFmwTrade»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.432. ResponseEntity«BuildingFmw»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.433. ResponseEntity«CatalogTree»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.434. ResponseEntity«CategoryEnterprise»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.435. ResponseEntity«CategoryKey»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.436. ResponseEntity«CategoryLocation»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.437. ResponseEntity«CategoryProject»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.438. ResponseEntity«CategoryStorageUrl»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.439. ResponseEntity«CategoryTask»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.440. ResponseEntity«CategoryUser»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.441. ResponseEntity«Contract»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.442. ResponseEntity«Country»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.443. ResponseEntity«Currency»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.444. ResponseEntity«EnterpriseLegalType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.445. ResponseEntity«EnterpriseRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.446. ResponseEntity«EnterpriseTrade»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.447. ResponseEntity«EnterpriseType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.448. ResponseEntity«EnterpriseUserRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.449. ResponseEntity«Enterprise»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.450. ResponseEntity«InvitedCoCo»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.451. ResponseEntity«LangCode»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.452. ResponseEntity«LocationRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.453. ResponseEntity«LocationStatus»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.454. ResponseEntity«LocationSubType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.455. ResponseEntity«LocationTrade»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.456. ResponseEntity«LocationType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.457. ResponseEntity«LocationUserRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.458. ResponseEntity«Location»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.459. ResponseEntity«LogEntry»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.460. ResponseEntity«NumWorkersOfEnterprise»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.461. ResponseEntity«Offer»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.462. ResponseEntity«ProjectEnterpriseCoCo»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.463. ResponseEntity«ProjectEnterpriseNotCoCo»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.464. ResponseEntity«ProjectRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.465. ResponseEntity«ProjectStatus»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.466. ResponseEntity«ProjectType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.467. ResponseEntity«ProjectUserRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.468. ResponseEntity«Project»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.469. ResponseEntity«ReferenceBuildingFramework»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.470. ResponseEntity«Requirement»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.471. ResponseEntity«ScArticle»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.472. ResponseEntity«ScVariableValue»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.473. ResponseEntity«ScVariable»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.474. ResponseEntity«StorageUrl»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.475. ResponseEntity«SurfaceUnit»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.476. ResponseEntity«TaskConnectionType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.477. ResponseEntity«TaskLocation»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.478. ResponseEntity«TaskRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.479. ResponseEntity«TaskTrade»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.480. ResponseEntity«TaskType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.481. ResponseEntity«TaskUserRole»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.482. ResponseEntity«TaskWorkLogType»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.483. ResponseEntity«TaskWorkLog»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.484. ResponseEntity«TasksConnection»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.485. ResponseEntity«Task»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.486. ResponseEntity«Trade»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.487. ResponseEntity«Type»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.488. ResponseEntity«Variable»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.489. ResponseEntity«VolumeUnit»

Name Schema

body
optional

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer (int32)

3.490. ScArticle

Name Schema

amount
optional

number

catalogTree
optional

disabled
optional

id
optional

integer (int32)

information
optional

string

name
optional

string

position
optional

string

unit
optional

string

3.491. ScArticleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.492. ScVariable

Name Schema

disabled
optional

id
optional

integer (int32)

name
optional

string

scArticle
optional

3.493. ScVariableService

Name Schema

conversionService
optional

filePersistenceService
optional

3.494. ScVariableValue

Name Schema

id
optional

integer (int32)

pos
optional

integer (int32)

scVariable
optional

value
optional

string

3.495. ScVariableValueService

Name Schema

conversionService
optional

filePersistenceService
optional

3.496. Serializable

Type : object

3.497. Sort

Name Schema

empty
optional

boolean

sorted
optional

boolean

unsorted
optional

boolean

3.498. StorageUrl

Base auditable type with integer ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

length
optional

integer (int64)

mimeType
optional

string

url
optional

string

urlMediumImage
optional

string

urlSmallImage
optional

string

3.499. StorageUrlService

Name Schema

conversionService
optional

filePersistenceService
optional

3.500. SurfaceUnit

Name Schema

id
optional

integer (int32)

name
optional

string

3.501. SurfaceUnitService

Name Schema

conversionService
optional

filePersistenceService
optional

3.502. Task

Base auditable, disableable type with integer ID

Name Description Schema

blocked
optional

integer (int32)

budget
optional

integer (int32)

buffer
optional

integer (int32)

createdDate
optional
read-only

Date created

string (date-time)

dateFrom
optional

dateTo
optional

description
optional

string

enterprise
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

order
optional

integer (int32)

parent
optional

project
optional

starred
optional

boolean

status
optional

type
optional

unitBlocked
optional

unitBudget
optional

unitBuffer
optional

3.503. TaskConnectionType

Name Schema

id
optional

integer (int32)

name
optional

string

3.504. TaskConnectionTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.505. TaskLocation

Base auditable, disableable type with composite ID

Name Schema

createdDate
optional

string (date-time)

disabled
optional

string (date-time)

id
required

lastModifiedDate
optional

string (date-time)

3.506. TaskLocationPK

A composite identifier (Task.id, Location.id) used in TaskLocation entities

Name Schema

left
required

right
required

3.507. TaskLocationService

Name Schema

conversionService
optional

filePersistenceService
optional

3.508. TaskRole

Name Schema

id
optional

integer (int32)

name
optional

string

3.509. TaskRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.510. TaskService

Name Schema

conversionService
optional

filePersistenceService
optional

3.511. TaskTrade

Base auditable, disableable type with composite ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

disabled
optional
read-only

Date disabled

string (date-time)

id
required

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

3.512. TaskTradePK

A composite identifier (Task.id, Trade.id) used as ID in TaskTrade entities

Name Schema

left
required

right
required

3.513. TaskTradeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.514. TaskType

Name Schema

id
optional

integer (int32)

name
optional

string

3.515. TaskTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.516. TaskUserRole

Base auditable, disableable type with integer ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

enterprise
optional

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

role
optional

task
optional

used
optional

3.517. TaskUserRoleService

Name Schema

conversionService
optional

filePersistenceService
optional

3.518. TaskWorkLog

Base auditable, disableable type with integer ID

Name Description Schema

attachment
optional

createdDate
optional
read-only

Date created

string (date-time)

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

message
optional

string

reporter
optional

task
optional

timestamp
optional

trade
optional

type
optional

3.519. TaskWorkLogService

Name Schema

conversionService
optional

filePersistenceService
optional

3.520. TaskWorkLogType

Name Schema

id
optional

integer (int32)

isStartType
optional

boolean

name
optional

string

3.521. TaskWorkLogTypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.522. TasksConnection

Base auditable, disableable type with composite ID

Name Schema

comment
optional

string

connectionType
optional

createdDate
optional

string (date-time)

disabled
optional

string (date-time)

id
required

lastModifiedDate
optional

string (date-time)

3.523. TasksConnectionPK

A composite identifier (Task.id, Task.id) used in TasksConnection entities

Name Schema

left
required

right
required

3.524. TasksConnectionService

Name Schema

conversionService
optional

filePersistenceService
optional

3.525. Timestamp

Name Schema

date
optional

integer (int32)

day
optional

integer (int32)

hours
optional

integer (int32)

minutes
optional

integer (int32)

month
optional

integer (int32)

nanos
optional

integer (int32)

seconds
optional

integer (int32)

time
optional

integer (int64)

timezoneOffset
optional

integer (int32)

year
optional

integer (int32)

3.526. Trade

Name Schema

id
optional

integer (int32)

name
optional

string

parent
optional

selectable
optional

boolean

3.527. TradeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.528. Type

Base auditable type with integer ID

Name Description Schema

createdDate
optional
read-only

Date created

string (date-time)

id
optional

integer (int32)

lastModifiedDate
optional
read-only

Date last modified

string (date-time)

name
optional

string

3.529. TypeService

Name Schema

conversionService
optional

filePersistenceService
optional

3.530. UiSchema

Name Schema

json
optional

string

3.531. User

Name Schema

aboutMe
optional

string

acceptScTerms
optional

boolean

birthdate
optional

string (date)

captchaResponse
optional

string

confirmedDate
optional

string (date)

confirmedUser
optional

string

countryOfResidence
optional

createdById
optional

integer (int32)

createdDate
optional

string (date-time)

disabled
optional

string (date)

email
optional

string

givenName
optional

string

id
optional

integer (int32)

idCardUrl
optional

string

isAdmin
optional

boolean

lastModifiedById
optional

integer (int32)

lastModifiedDate
optional

string (date-time)

male
optional

boolean

name
optional

string

nationality
optional

new
optional

boolean

newEmail
optional

string

password
optional

string

phone
optional

string

pictureUrl
optional

string

prefLang
optional

receiveMessages
optional

boolean

roles
optional

< string > array

scVerified
optional

string (date)

ssn
optional

string

surName
optional

string

telephone
optional

string

title
optional

string

userName
optional

string

userPool
optional

string

version
optional

integer (int64)

webSiteUrl
optional

string

3.532. UserDto

Name Schema

admin
optional

boolean

blocked
optional

boolean

goodAdmin
optional

boolean

goodUser
optional

boolean

id
optional

string

password
optional

string

roles
optional

< string > array

tag
optional

unverified
optional

boolean

username
optional

string

3.533. Variable

Name Schema

id
required

pos
optional

integer (int32)

scVariable
optional

3.534. VariablePK

A composite identifier used in Variable

Name Schema

article
required

name
optional

string

value
optional

string

3.535. VariableService

Name Schema

conversionService
optional

filePersistenceService
optional

3.536. VolumeUnit

Name Schema

id
optional

integer (int32)

name
optional

string

3.537. VolumeUnitService

Name Schema

conversionService
optional

filePersistenceService
optional